Organisations
List organisations
GET
Authorizations
Enter your personal access token (PAT) to authenticate
Path Parameters
The UUID of the workspace
Example:
"550e8400-e29b-41d4-a716-446655440000"
Query Parameters
Optional segment UUID for filtering organisations
Example:
"550e8400-e29b-41d4-a716-446655440000"
The page number for pagination
Example:
1
The number of organisations per page (1-1000)
Required range:
1 <= x <= 1000
Example:
10
The specific date to filter organisations that visited that day.
Example:
"2025-03-01"
The start date for filtering organisations based on visits. Can only be used if date
is not provided.
Example:
"2025-03-01"
The end date for filtering organisations based on visits. Can only be used if date
is not provided.
Example:
"2025-03-10"
Filters organisations where the name contains the given string.
Example:
"Pirate"
Response
200 - application/json
A paginated list of organisations
The response is of type object
.