Skip to content

Sign inOpen console
Browse the docs

GET /contacts/{id}/segments

Segments whose rules include this contact.

Request

The same call in curl, Node and Python. A path id in the sample is a placeholder.

curl

curl -sS -X GET https://api.agentisend.com/contacts/9c8f8f0e-3d1a-4d3f-9a1e-2b7c1a0f5e42/segments \
  -H "Authorization: Bearer $AGENTISEND_API_KEY"

Node

import { AgentiSend } from 'agentisend';

const client = new AgentiSend(process.env.AGENTISEND_API_KEY);
const result = await client.request({
  method: 'GET',
  path: '/contacts/9c8f8f0e-3d1a-4d3f-9a1e-2b7c1a0f5e42/segments',
});

Python

import json, os, urllib.request

url = 'https://api.agentisend.com/contacts/9c8f8f0e-3d1a-4d3f-9a1e-2b7c1a0f5e42/segments'
headers = {'Authorization': 'Bearer ' + os.environ['AGENTISEND_API_KEY']}
request = urllib.request.Request(url, headers=headers, method='GET')
print(urllib.request.urlopen(request).read().decode())

Tag: contacts. Generated from openapi.json; the anchor get-contacts-id-segments is the id the console's error fix links point at.

Parameters

  • id path · string · required

Responses

  • 200 — Success
  • 400 — The request is malformed or a field failed validation. Codes: validation_error, invalid_idempotency_key, invalid_cursor, plan_not_purchasable, stripe_signature_invalid, support_upload_rejected, sign_in_check_required.
  • 429 — A rate, quota or ramp ceiling was reached. Codes: onboarding_daily_cap_reached, trust_throttled, invite_limit_reached, rate_ceiling_exceeded, daily_quota_exceeded, monthly_quota_exceeded, rate_limit_exceeded, support_rate_limited.
  • 500 — Something failed on our side. Codes: internal_server_error.

Response headers

  • ratelimit-limit — Messages this API key may spend in one 60-second window.
  • ratelimit-remaining — Messages left in the current window.
  • ratelimit-reset — Seconds until the current window resets and the budget refills.

200 body

FieldTypeRequiredNotes
dataarray<object>yes
data[].created_atstringyes
data[].idstringyes
data[].namestringyes
has_morebooleanyes
next_cursorstring | nullyes
objectstringyes

Response example

200
{
  "data": [],
  "has_more": false,
  "next_cursor": "example",
  "object": "list"
}

Errors

The codes this operation can answer with, and what to do about each. Every one arrives with its code, message, fix and docs_url.

  • internal_server_error (500, internal_server_error) — Unexpected error. Fix: Retry ONCE after a short pause, with the same Idempotency-Key so the retry cannot double-send. If it fails again, stop retrying and report the x-request-id from the response — that id is what identifies this exact failure in support.
  • rate_limit_exceeded (429, rate_ceiling_exceeded, rate_limit_exceeded) — Too many requests. Fix: Back off and retry honoring the Retry-After header.
  • validation_error (400, domain_not_verified, invalid_parameter, validation_error) — Error in one or more fields. Fix: Correct the fields listed in the error details and retry the request.
PreviousPOST /contacts/{id}/resubscribeNextPOST /contacts/{id}/segments/{segmentId}