Skip to main content
GET
/
people-relationships
List People
curl --request GET \
  --url https://crm.universal.rollout.com/api/people-relationships \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Rollout-Credential-Id: <api-key>'
{
  "_metadata": {
    "collection": "<string>",
    "offset": 123,
    "limit": 123,
    "total": 123,
    "next": "<string>",
    "nextLink": "<string>"
  },
  "people-relationships": [
    {
      "id": "<string>",
      "personId": "<string>",
      "type": "<string>",
      "isPriority": true,
      "firstName": "<string>",
      "lastName": "<string>",
      "emails": [
        {
          "value": "<string>",
          "type": "<string>",
          "status": "<string>",
          "isPrimary": true
        }
      ],
      "phones": [
        {
          "value": "<string>",
          "type": "<string>",
          "status": "<string>",
          "isPrimary": true
        }
      ],
      "addresses": [
        {
          "type": "<string>",
          "street": "<string>",
          "city": "<string>",
          "state": "<string>",
          "code": "<string>",
          "country": "<string>",
          "county": "<string>"
        }
      ],
      "created": "<string>",
      "updated": "<string>",
      "rolloutUpdated": "<string>",
      "originalIds": {},
      "original": {}
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://rollout.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Authorization JWT

X-Rollout-Credential-Id
string
header
required

The Rollout Credential ID to use for queries/mutations

Query Parameters

next
string
offset
default:0
limit
number

Response

OK

_metadata
object
required
people-relationships
object[]
required