Skip to main content
GET
cURL

Authorizations

x-api-key
string
header
required

API Key authentication. Format: 'x-api-key: api_key'

Query Parameters

active
boolean
archived
boolean
connector_slug
string
created_at__gt
string<date-time>
created_at__gte
string<date-time>
created_at__lt
string<date-time>
created_at__lte
string<date-time>
created_by
integer
draft
boolean
error
boolean
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

A search term.

slug
string
sort
enum<string>[]

Ordering

  • slug - Slug
  • -slug - Slug (descending)
  • connector_slug - Connector slug
  • -connector_slug - Connector slug (descending)
  • description - Description
  • -description - Description (descending)
  • created_by - Created by
  • -created_by - Created by (descending)
  • active - Active
  • -active - Active (descending)
  • created_at - Created at
  • -created_at - Created at (descending)
  • updated_at - Updated at
  • -updated_at - Updated at (descending)
Available options:
-active,
-connector_slug,
-created_at,
-created_by,
-description,
-slug,
-updated_at,
active,
connector_slug,
created_at,
created_by,
description,
slug,
updated_at
tag
string
updated_at__gt
string<date-time>
updated_at__gte
string<date-time>
updated_at__lt
string<date-time>
updated_at__lte
string<date-time>

Response

200 - application/json
count
integer
required
Example:

123

results
object[]
required
next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"