segments

Check whether a contact is in a Segment

GET /v1/segments/{id}/members/{contactId}

Auth required api.segments.view

Returns the membership boolean for a contact in a Segment. A missing Segment is 404 not_found, but a non-member contact returns 200 with is_member: false.

Path parameters

id string<uuid> required

Resource UUID. An unparseable id reads as a clean 404 not_found.

contactId string<uuid> required

Contact UUID. Malformed values return 422 validation_failed.

Responses

200 Membership result application/json

401 Missing, malformed, or unknown API key application/problem+json

403 Key lacks the required scope or plan limit violated application/problem+json

404 Resource not found application/problem+json

422 Query parameter or path value failed validation application/problem+json

429 Per-org rate limit exceeded application/problem+json

500 Unexpected server-side failure. The code is internal_error. The request_id field can be quoted to SendOps support to investigate. application/problem+json

curl 'https://api.sendops.dev/v1/segments/00000000-0000-0000-0000-000000000000/members/00000000-0000-0000-0000-000000000000' \
  -H "Authorization: Bearer $SENDOPS_API_KEY"

const res = await fetch("https://api.sendops.dev/v1/segments/00000000-0000-0000-0000-000000000000/members/00000000-0000-0000-0000-000000000000", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.SENDOPS_API_KEY}`
  },
});
const body = await res.json();

import os, requests

r = requests.get("https://api.sendops.dev/v1/segments/00000000-0000-0000-0000-000000000000/members/00000000-0000-0000-0000-000000000000", headers={"Authorization": f"Bearer {os.environ['SENDOPS_API_KEY']}"})
print(r.json())

application/json

{
  "segment_id": "00000000-0000-0000-0000-000000000000",
  "contact_id": "00000000-0000-0000-0000-000000000000",
  "is_member": true
}

{
  "type": "https://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "invalid_key",
  "request_id": "string",
  "retry_after": 0,
  "retention_days": 0,
  "scope": "string",
  "resource": "string",
  "errors": [
    {
      "field": "string",
      "reason": "string"
    }
  ]
}

{
  "type": "https://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "invalid_key",
  "request_id": "string",
  "retry_after": 0,
  "retention_days": 0,
  "scope": "string",
  "resource": "string",
  "errors": [
    {
      "field": "string",
      "reason": "string"
    }
  ]
}

{
  "type": "https://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "invalid_key",
  "request_id": "string",
  "retry_after": 0,
  "retention_days": 0,
  "scope": "string",
  "resource": "string",
  "errors": [
    {
      "field": "string",
      "reason": "string"
    }
  ]
}

{
  "type": "https://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "invalid_key",
  "request_id": "string",
  "retry_after": 0,
  "retention_days": 0,
  "scope": "string",
  "resource": "string",
  "errors": [
    {
      "field": "string",
      "reason": "string"
    }
  ]
}

{
  "type": "https://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "invalid_key",
  "request_id": "string",
  "retry_after": 0,
  "retention_days": 0,
  "scope": "string",
  "resource": "string",
  "errors": [
    {
      "field": "string",
      "reason": "string"
    }
  ]
}

{
  "type": "https://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "invalid_key",
  "request_id": "string",
  "retry_after": 0,
  "retention_days": 0,
  "scope": "string",
  "resource": "string",
  "errors": [
    {
      "field": "string",
      "reason": "string"
    }
  ]
}