List segments / lead lists exposed by the CRM

GET /crm/connections/{id}/segments

List segments / lead lists exposed by the CRM

cURL

curl --request GET \
  --url https://api.pineyard.ai/crm/connections/{id}/segments \
  --header 'Authorization: Bearer <token>'

200

{
  "segments": [
    {
      "externalId": "<string>",
      "name": "<string>",
      "count": 123
    }
  ]
}

Required scope: crm.view

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Path Parameters

id · string · required

Response

200

application/json

OK

segments · object[] · required

Show child attributes