Sign in
Cloud Internal

List subjects

List subjects on the UI.

get/api/internal/subjects

Query parameters

pageinteger

Page index.

Default is 1.

pageSizeinteger

The maximum number of items per page.

Default is 100.

searchstring

Search for subjects by key or display name.

sort'key:asc' | 'key:desc' | 'displayName:asc' | 'displayName:desc'

Sort subjects by key or display name.

Response

The request has succeeded.

pageinteger required

The page index.

pageSizeinteger required

The maximum number of items per page.

totalCountinteger required

The total number of items.

Example response

{
  "items": [
    {
      "createdAt": "2025-01-01T01:01:01.001Z",
      "deletedAt": "2025-03-01T01:01:01.001Z",
      "displayName": "Customer Name",
      "id": "01G65Z755AFWAKHE12NY0CQ9FH",
      "key": "customer-id",
      "metadata": {
        "hubspotId": "123456"
      },
      "stripeCustomerId": "cus_JMOlctsKV8",
      "updatedAt": "2025-02-01T01:01:01.001Z"
    }
  ],
  "page": 1,
  "pageSize": 100,
  "totalCount": 500
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.