Universal CRM API Documentation

Development documentation

Server

https://crm.universal.rollout.com/api

Client Libraries

Curl Shell

People

People Operations

GET/people
POST/people
GET/people/{id}
PUT/people/{id}
DELETE/people/{id}
POST/people/{id}/tags/apply
POST/people/{id}/tags/delete

/people

Query Parameters

next
Type:string
offset
Any of
Hide Child Attributesfor offset
Type:string Format: numeric
default:
0
limit
Type:number

Responses

Request Example forGET/people

Selected HTTP client: Shell Curl

curl https://crm.universal.rollout.com/api/people

Show Schema

{
  "_metadata": {
    "collection": "…",
    "offset": 1,
    "limit": 1,
    "total": 1,
    "next": "…",
    "nextLink": "…"
  },
  "people": [
    {
      "id": "…",
      "name": "…",
      "firstName": "…",
      "lastName": "…",
      "assignedUserId": "…",
      "stage": "…",
      "stageId": "…",
      "tags": [
        "…"
      ],
      "originalIds": {
        "^(.*)$": 1
      },
      "original": {
        "^(.*)$": {
          "^(.*)$": null
        }
      },
      "created": "…",
      "updated": "…",
      "addresses": [
        {
          "type": "…",
          "street": "…",
          "city": "…",
          "state": "…",
          "code": "…",
          "country": "…"
        }
      ],
      "emails": [
        {
          "value": "…",
          "type": "…",
          "status": "…",
          "isPrimary": true
        }
      ],
      "phones": [
        {
          "value": "…",
          "type": "…",
          "status": "…",
          "isPrimary": true
        }
      ],
      "source": "…",
      "contactTypes": [
        "…"
      ],
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ]
}

Notes (Collapsed)

Notes Operations

GET/notes
POST/notes
GET/notes/{id}
PUT/notes/{id}
DELETE/notes/{id}

Users (Collapsed)

Users Operations

GET/users
POST/users
GET/users/{id}
PUT/users/{id}
DELETE/users/{id}