List registry — StatusDashboard Docs

GET /app/segments/registry

Returns paginated registry entries. Assignments are independent of dashboard subscription state — contacts appear here whether or not they are subscribers.

Request

See API Basics for required headers.

Query parameters

Parameter	Type	Required	Description
`limit`	integer	No	Max items per page. Range: 1–100. Default: `25`.
`nextToken`	string	No	Next-page bookmark from the previous response — pass unchanged. See Pagination.
`tagId`	uuid	No	Filter to assignments for a single tag.
`contact`	string	No	Exact-match search by email or phone. Validated and normalized to the same `normalizedContact` format used by Create registry assignment (lowercased email or E.164 phone, e.g. `+14155552671`).

contact may be combined with tagId to search within one tag.

Sample request

Browse a single tag:

curl "https://api.statusdashboard.com/app/segments/registry?tagId=a1b2c3d4-e5f6-7890-abcd-ef1234567890&limit=25" \
  -H "Authorization: Bearer bcf847abf5c6:def456"

Search by email across all tags:

curl "https://api.statusdashboard.com/app/segments/registry?contact=ceo%40acme.com&limit=25" \
  -H "Authorization: Bearer bcf847abf5c6:def456"

Search by phone within one tag:

curl "https://api.statusdashboard.com/app/segments/registry?tagId=a1b2c3d4-e5f6-7890-abcd-ef1234567890&contact=%2B15550109999&limit=25" \
  -H "Authorization: Bearer bcf847abf5c6:def456"

Sample response

Status: 200 OK

{
  "entries": [
    {
      "tagId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "tagName": "Executive",
      "channel": "email",
      "displayName": "Jane Doe, CEO",
      "contact": "ceo@acme.com",
      "normalizedContact": "ceo@acme.com",
      "createdAt": "2026-06-02T09:00:00.000Z"
    },
    {
      "tagId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "tagName": "Executive",
      "channel": "sms",
      "displayName": "Jane Doe, CEO",
      "contact": "+1 555 010 9999",
      "normalizedContact": "+15550109999",
      "createdAt": "2026-06-02T09:15:00.000Z"
    },
    {
      "tagId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "tagName": "Executive",
      "channel": "whatsapp",
      "displayName": "Jane Doe, CEO",
      "contact": "+1 415 555 2671",
      "normalizedContact": "+14155552671",
      "createdAt": "2026-06-02T09:30:00.000Z"
    }
  ],
  "nextToken": null
}

Response fields

Field	Type	Description
`entries`	array	Page of registry assignments.
`entries[].tagId`	string	Tag UUID.
`entries[].tagName`	string	Resolved tag display name.
`entries[].channel`	string	`email`, `sms`, or `whatsapp`.
`entries[].displayName`	string	Human-readable label set when the contact was added.
`entries[].contact`	string	Email or formatted phone value.
`entries[].normalizedContact`	string	Canonical value for DELETE: lowercased email or E.164 phone.
`entries[].createdAt`	string	ISO 8601 assignment timestamp.
`nextToken`	string \| null	See Pagination. `null` when there are no more pages.

Pagination

See Pagination in API Basics. Re-send the same query parameters on every page request.

Error responses

Status	When
`400`	Invalid query parameters, invalid `contact` (not a valid email or phone), or invalid `nextToken`.
`403`	Caller is not an org admin, or the organization segments feature is not enabled.