provider Contacts API - Segments GET /contactdb/segments/{segment_id}
@utdk/sendgrid /contactdb/segments/{segment_id}
Retrieve a segment
**This endpoint allows you to retrieve a single segment with the given ID.**
segment_id path required
string
segment_id query required
The ID of the segment you want to request.
integer
on-behalf-of header
string

Try it

Authentication
Configure credentials for Email Activity (beta)
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

getContactdbSegmentsSegmentId
GET/contactdb/segments/{segment_id}
**This endpoint allows you to retrieve a single segment with the given ID.**

Parameters

required

required

The ID of the segment you want to request.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import sendgrid from '@utdk/sendgrid';

await sendgrid.getContactdbSegmentsSegmentId({
  "on-behalf-of": "The subuser's username. This header generates the API call as if the subuser account was making the call."
})