List segments

GET/v1/segments

Responses

200Page of Segment
Every segment, by name
401Error
Missing, malformed, or revoked API key
402Error
Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
429Error
Rate limit or quota exceeded

Response Fields

The body is a page: data (the array), has_more, and next_cursor (null on the last page). Each item in data:

idstring
Example: seg_a1B2c3D4e5F6.
objectsegment
namestring
descriptionstring
Nullable.
matchall, any
rulesarray of SegmentRule
created_atstring (date-time)
updated_atstring (date-time)

Errors

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

401
Missing, malformed, or revoked API key
402
Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
429
Rate limit or quota exceeded

const res = await fetch('https://api.jointextkit.com/v1/segments', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.TEXTKIT_API_KEY}`,
  },
});

if (!res.ok) throw new Error((await res.json()).error.message);
const data = await res.json();

Response 200

{
  "data": [
    {
      "id": "seg_a1B2c3D4e5F6",
      "object": "segment",
      "match": "all"
    }
  ],
  "has_more": true,
  "next_cursor": null
}