Referencia API

List Bookings

get
https://connect.agendapro.com/v3/bookings

This endpoint returns a paginated list of bookings for the company.

Important Notes

  • Results are scoped to the company associated with the API key.
  • At least one entity filter is required: client_id, location_id, service_id, or service_provider_id. The start_date/end_date parameters narrow results further but do not satisfy this requirement on their own.
  • Requires bookings:read scope.

Errors Dictionary

StatusErrorDetailDescription
400requiredparamsNo entity filter provided. Supply at least one of client_id, location_id, service_id, or service_provider_id.
401unauthorizedinvalid_api_keyMissing or invalid Bearer token.
401unauthorizedapi_config_inactiveAPI access is inactive for this company.
403forbiddenscope_deniedAPI key lacks bookings:read scope.
429rate_limitedburst_limit_exceededPer-minute request limit exceeded.
429rate_limiteddaily_quota_exceededDaily request quota exceeded.
502upstream_unavailableThe upstream service is unavailable.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer

Filter by client ID.

integer

Filter by location ID.

integer

Filter by service ID.

integer

Filter by service provider ID.

boolean

Filter by scheduled status.

integer

Filter by status ID.

date

Filter bookings from this date (YYYY-MM-DD).

date

Filter bookings until this date (YYYY-MM-DD).

integer
≥ 1
Defaults to 1

Page number (defaults to 1).

integer
1 to 100
Defaults to 30

Records per page (defaults to 30, max 100).

Responses

Updated about 1 month ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago