API Reference
  1. Ekas API
  2. Registrations

List registrations

get
https://app.ekas.io/v1/registrations

Paginated list of registrations, newest first. Use updated_at_gte/updated_at_lte for delta-sync polling and external_id to reconcile against provider-side identifiers (matches any of tcr_brand_id, tcr_campaign_id, provider_sid).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

Filter by registration type.

Allowed:
string
enum

Filter by compliance channel.

Allowed:
status
array of objects

Filter by one or more spine statuses.

status
string

Only registrations whose subject belongs to this brand.

string

Only registrations delivered through this provider connection.

string

Reconciliation lookup — matches any of tcr_brand_id, tcr_campaign_id, provider_sid, or rbm_agent_id.

boolean

Filter to imported (true) or Ekas-created (false) registrations.

ids
array of strings
length ≤ 100

Return only these ids (up to 100).

ids
string

Filter to resources belonging to one subaccount.

date-time

Only resources created at or after this time (ISO 8601).

date-time

Only resources created at or before this time (ISO 8601).

date-time

Only resources updated at or after this time — use for delta sync.

date-time

Only resources updated at or before this time.

metadata
object

Filter by metadata key-value pairs (up to 3), e.g. metadata[customer_ref]=acct_42.

integer
1 to 100
Defaults to 25

Page size (1-100, default 25).

string

Opaque cursor from a previous response's next_cursor.

Responses

Updated 1 day ago

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

Updated 1 day ago

Did this page help you?