List Segments

GEThttps://api.inboxjot.com/v1/segments

Lists the segments of the workspace, newest first, with the exact total. Needs a Full key. A key limited to one domain answers 403.

Lists are paged with cursors. Read next_cursor and send it as after for the next page. A page has 50 items unless you set per_page, up to 100.

GET/v1/segments

1
2

curl -X GET https://api.inboxjot.com/v1/segments \
  -H "Authorization: Bearer $INBOXJOT_API_KEY"

{
  "data": [
    {
      "id": "seg_06d2mfk8r2kd7fq4mx9ab",
      "name": "Engaged customers",
      "description": null,
      "type": "dynamic",
      "contact_count": 1204,
      "counted_at": "2026-10-21T09:00:00.000Z",
      "created_at": "2026-10-01T12:00:00.000Z",
      "updated_at": "2026-10-01T12:00:00.000Z"
    }
  ],
  "prev_cursor": null,
  "next_cursor": null,
  "total": 1
}

Returns a page of segments.

Query Parameters

typestring

static or dynamic.

querystring

Text to find in the name, up to 200 characters.

sortstring

created, name or contacts. Defaults to created.

directionstring

asc or desc. Defaults to desc.

per_pageinteger

How many items to return, from 1 to 100. Defaults to 50.

afterstring

A next_cursor from the last page. Returns the items after it.

beforestring

A prev_cursor from the last page. Returns the items before it. When you send both, before wins.

Response

dataobject[]

The segments on this page.

prev_cursorstring | null

Send it as before to get the page before. null on the first page.

next_cursorstring | null

Send it as after to get the next page. null on the last page.

totalinteger

The exact number of segments that match the filters, on all pages.

Responses

{ "data": [ { "id": "seg_06d2mfk8r2kd7fq4mx9ab", "name": "Engaged customers", "description": null, "type": "dynamic", "contact_count": 1204, "counted_at": "2026-10-21T09:00:00.000Z", "created_at": "2026-10-01T12:00:00.000Z", "updated_at": "2026-10-01T12:00:00.000Z" } ], "prev_cursor": null, "next_cursor": null, "total": 1 }