API Reference

Groups

User groups, which permissions are granted to.

Prefix /cdna-api/users ReferenceGroup model GuideGroups
Groups in Postman

List groups#

GET /cdna-api/users/groups

Lists groups. Without limit every match comes back.

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

Parameters

propertiesquery
selector
The fields and relations to return, such as {id,peopleCount}.
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 groups 
GET /cdna-api/users/groups?limit=2&properties={id,peopleCount} HTTP/1.1
Host: hub.coredna.com
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json
Response 200 OK 
{
  "result": "success",
  "totalCount": 1,
  "data": [
    {
      "id": 3,
      "peopleCount": 2
    }
  ]
}
Open in Postman docs Real response from this documentation site

Create a group#

POST /cdna-api/users/group

Creates a group.

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

Parameters

namebody
string
The group’s name. Required.
textbody
string
A description.

Example

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

{
  "name": "Management",
  "text": "Group for managers or corporate"
}
Open in Postman docs

Edit a group#

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

Changes a group. Fields left out keep their values.

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

Parameters

idpathrequired
integer
The group id.
textbody
string
A description.

Example

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

{
  "text": "Private management group"
}
Open in Postman docs

Show a group#

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

Reads one group by its id.

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

Parameters

idpathrequired
integer
The group id.
propertiesquery
selector
The fields and relations to return, such as {id,peopleCount}.

Example

Show a group 
GET /cdna-api/users/group/3?properties={id,peopleCount} HTTP/1.1
Host: hub.coredna.com
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json
Response 200 OK 
{
  "result": "success",
  "data": {
    "id": 3,
    "peopleCount": 2
  }
}
Open in Postman docs Real response from this documentation site

Delete a group#

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

Deletes a group.

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

Parameters

idpathrequired
integer
The group id.

Example

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