URL & Endpoints
URL's
| Environment | URL |
|---|---|
| Production | https://api.caught.nu/v1 |
Available Endpoints
This is a list of the available Endpoints of the Caught API with their purpose.
| Type | Endpoint name | Purpose | Details |
|---|---|---|---|
| GET | /applications | View all available Applications in the Caught Platform under your account | Details |
| GET | /applications/{{applicationId}} | View a specific Application from your Caught account - the application Id can be copied from the URL when editing in Caught. | Details |
| GET | /locations/{{locationId}} | View a specific rollout (Location) in Caught under your account by its ID | Details |
| GET | /locations?applicationId={{applicationId}} | View all rollouts (Locations) for a specific Application in Caught under your account. | Details |
| GET | /groups/{{groupId}} | View a specific Group (booking/user) in Caught under your account by its ID | Details |
| GET | /groups?locationId={{locationId}} | View all non-archived Groups (bookings/users) under your account for a specific rollout (Location) by location ID. Add &archived=true to see archived Groups (up to 6 months back) | Details |
| GET | /teams/{{teamId}} | View Team info of specific Team by its ID | Details |
| GET | /teams?groupId={{groupId}} | View all Teams info of specific Group | Details |
| GET | /photos?groupId={{locationId}} | View a specific rollout (Location) in Caught under your account. | Details |
| POST | /groups?locationId={{locationId}} | Add a Group (user/booking) for a specific rollout (Location) by its location ID. (Singular) | Details |
| POST | /groups?locationId={{locationId}} | Add multiple Groups (users/bookings) for a specific rollout (Location) by its location ID. Same endpoint as for a single Group, but using a different payload. See details for an example. | Details |
| POST | /groups?locationId={{locationId}} | Add/Remove multiple Groups (users/bookings) for a specific rollout (Location) by its location ID. Same endpoint as for a single Group, but using a different payload, adding Group IDs to be removed. See details for an example. Can also be used to remove only, but a Location ID must be provided. | Details |
| POST | /teams?groupId={{groupId}} | Add a Team to a specific Group by its Group ID | Details |
| POST | /teams?groupId={{groupId}} | Add multiple Teams in batch, for a specific Group ID. Same endpoint as for a single Team, but using a different payload using batch info (Name prefix, PIN code per Team and generateAccessCode) | Details |
| DELETE | /groups/{{groupId}} | Remove a single Group (user/booking) by its Group ID. | Details |
| DELETE | /groups | Remove multiple Groups (users/bookings) by their Group ID. Provide an Array of Group Ids in the payload. See details for an example. | Details |
Postmark Documentation
For more detailed information on each of the Endpoints, you can view the more detailed Postman Documentation with Code Examples for your programming language.
