API Reference

People

Person records, the identity behind a user account.

Prefix /cdna-api/users ReferencePerson model GuidePeople, users, groups and permissions
People in Postman

List people#

GET /cdna-api/users/people

Lists people. Without limit every match comes back. The example filters by the person’s user.

Access
Admin users and integrations, with an OAuth access token or an API key.
Model
Person, in the Reference

Parameters

propertiesquery
selector
The fields and relations to return, such as {id,fullName,email}.
filtersquery
name=value
Any stored field, or a relation with a dot, such as parent.id=12. Prefix the name with !, >, <, % or |. Use stored field names exactly as in the model, and compare totalCount with the unfiltered list's to confirm a filter applied.
orderByquery
string
field:ASC or field:DESC, comma-separated. Stored fields only.
limitquery
integer
Records per response. There is no default.
offsetquery
integer
Records to skip.

Example

List people 
GET /cdna-api/users/people?user.id=63&properties={id,fullName,email} HTTP/1.1
Host: hub.coredna.com
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json
Response 200 OK 
{
  "result": "success",
  "totalCount": 1,
  "data": [
    {
      "id": 135,
      "fullName": "API docs bot",
      "email": "person@example.com"
    }
  ]
}
Open in Postman docs Real response from this documentation site

Create a person#

POST /cdna-api/users/person

Creates a person.

Access
Admin users and integrations, with an OAuth access token or an API key.
Returns
The new person under data.person, and a message.

Parameters

emailbody
string
The email address.
firstNamebody
string
The first name.
lastNamebody
string
The last name.

Example

Create a person 
POST /cdna-api/users/person HTTP/1.1
Host: hub.coredna.com
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json
Content-Type: application/json

{
  "email": "person@example.com",
  "firstName": "Alex",
  "lastName": "Example"
}
Open in Postman docs

Edit a person#

PUT /cdna-api/users/person/{id}

Changes a person. Fields left out keep their values.

Access
Admin users and integrations, with an OAuth access token or an API key.
Returns
The saved person under data.person, and a message.

Parameters

idpathrequired
integer
The person id.
titlebody
string
The title, such as Mr or Dr.

Example

Edit a person 
PUT /cdna-api/users/person/50 HTTP/1.1
Host: hub.coredna.com
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json
Content-Type: application/json

{
  "title": "Mr"
}
Open in Postman docs

Show a person#

GET /cdna-api/users/person/{id}

Reads one person by its id.

Access
Admin users and integrations, with an OAuth access token or an API key.
Model
Person, in the Reference

Parameters

idpathrequired
integer
The person id.
propertiesquery
selector
The fields and relations to return, such as {id,fullName,email}.

Example

Show a person 
GET /cdna-api/users/person/135?properties={id,fullName,email} HTTP/1.1
Host: hub.coredna.com
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json
Response 200 OK 
{
  "result": "success",
  "data": {
    "id": 135,
    "fullName": "API docs bot",
    "email": "person@example.com"
  }
}
Open in Postman docs Real response from this documentation site

Delete a person#

DELETE /cdna-api/users/person/{id}

Deletes a person.

Access
Admin users and integrations, with an OAuth access token or an API key.

Parameters

idpathrequired
integer
The person id.

Example

Delete a person 
DELETE /cdna-api/users/person/50 HTTP/1.1
Host: hub.coredna.com
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json
Open in Postman docs