Resources for managing people

/orgs/{org_id}/merges

POST

/orgs/{org_id}/people

GET

POST

/orgs/{org_id}/people/{person_id}

DELETE

GET

PATCH

/orgs/{org_id}/people/{person_id}/avatar

GET

/orgs/{org_id}/people/{person_id}/fields

Values for custom fields on this person.

GET

Get values for all fields that have been set on this person.

/orgs/{org_id}/people/{person_id}/fields/{field_id}

Get/set custom field values for this person.

DELETE

Delete (unset) the value of field field_id (ID or slug) for this person.

Trying to delete a value for a field which has not been set will return a 404 (Not found) error code.

As an alternative, you can PUT an empty value which will also cause the field to be unset, but always returns 204 (No Content).

GET

Get value of field field_id (ID or slug) for this person. The value is returned as the data property of the response, or null if no value has been set.

PUT

Set or update the value of field field_id (ID or slug) for this person.

The request body will be parsed as JSON and assigned to the field. This means that the content can be anything allowed in JSON, including objects and lists (if the type of the field is json).

A null/empty value will unset the field for this person. This is similar to DELETE, but will not return 404 if the value is not already set.

/orgs/{org_id}/people/{person_id}

DELETE

GET

PATCH

/orgs/{org_id}/people/{person_id}/notes

GET

POST

/orgs/{org_id}/people/{person_id}/notes/{note_id}

DELETE

/orgs/{org_id}/people/{person_id}/tags

GET

/orgs/{org_id}/people/{person_id}/tags/{tag_id}

DELETE

PUT

/orgs/{org_id}/people/{person_id}/timeline

GET

/orgs/{org_id}/people/fields

Custom fields that can be assigned to Person objects.

GET

Returns a list of existing custom field configurations.

POST

/orgs/{org_id}/people/fields/{field_id}

Custom field that can be assigned values to Person objects.

DELETE

GET

Returns a single custom field configuration.

PATCH

/orgs/{org_id}/groups

GET

POST

/orgs/{org_id}/groups/{group_id}

DELETE

GET

PATCH

/orgs/{org_id}/groups/{group_id}

DELETE

GET

PATCH

/orgs/{org_id}/groups/{group_id}/managers

GET

/orgs/{org_id}/groups/{group_id}

DELETE

GET

PATCH

/orgs/{org_id}/groups/{group_id}/members

GET

/orgs/{org_id}/groups/{group_id}/members/{person_id}

DELETE

PATCH

PUT

/orgs/{org_id}/group_categories

GET

POST

/orgs/{org_id}/group_categories/{cat_id}

DELETE

GET

PATCH

/orgs/{org_id}/imports

GET

POST

/orgs/{org_id}/people/tags

GET

POST

/orgs/{org_id}/people/tags/{tag_id}

DELETE

GET

PATCH

/orgs/{org_id}/people/tags/{tag_id}/people

GET