Skip to main content
GET
List

Authorizations

X-API-Key
string
header
required

Your API key from the Studio Dashboard

Query Parameters

page
integer
default:1

Page number, 1-indexed.

Required range: x >= 1
page_size
integer
default:50

Items per page. Default 50, max 100.

Required range: 1 <= x <= 100
uuid
string<uuid>

Filter to one agency by UUID.

slug
string

Filter to one agency by slug.

Maximum string length: 128

Substring match across name, slug, and code.

Maximum string length: 128
status
enum<string>
Available options:
active,
moderation,
disabled
topagencies_publish
enum<string>
Available options:
true,
false,
1,
0
sort
enum<string>
default:created_at_desc

Sort order.

  • created_at_desc: newest agencies first (default).
  • created_at_asc: oldest agencies first.
  • updated_at_desc: most recently updated first.
  • updated_at_asc: least recently updated first.
  • name_asc: by name A→Z.
  • name_desc: by name Z→A.
Available options:
created_at_desc,
created_at_asc,
updated_at_desc,
updated_at_asc,
name_asc,
name_desc

Response

Successful response

success
boolean
Example:

true

data
object[]
pagination
object

Page-based pagination, returned by every list endpoint that isn't a cursor feed.