REST API Users, roles, units and permissionsClients

Clients

Clients: list, get, create, update and delete, plus batch operations.

The summaries on this page are generated from the specification; written descriptions come with the next releases of the reference.

Method	Path	Operation
GET	`/entities/Clients`	List Clients
POST	`/entities/Clients`	Create Client
GET	`/entities/Clients/{id}`	Get Client
PATCH	`/entities/Clients/{id}`	Update Client
DEL	`/entities/Clients/{id}`	Delete Client
POST	`/entities/Clients/batch-modify`	Create or update Clients in a batch
POST	`/entities/Clients/batch-delete`	Delete Clients in a batch
POST	`/entities/Clients/batch-restore`	Restore deleted Clients

GET List Clients

Returns the Clients the API application can read, one page at a time. In the list envelope, total counts every match and page_info pages through them.

Query parameters

Name	Type	Description
`include-deleted`	boolean	Include soft-deleted records. Lists only; get-by-id refuses it.
`first`	integer	Page size. Default 30, maximum 100; a larger value is refused with HTTP 400, code 117.
`last`	integer	Return the last N records of the result; together with `first`, the last N of the first M. Maximum 100.
`before`	string	Cursor from `page_info.start_cursor`, to page backwards. URL-encode it.
`after`	string	Cursor from `page_info.end_cursor` of the previous page. URL-encode it: cursors are base64, and a raw + becomes a space.
`expand`	string	Related records to return inline instead of their URIs, comma-separated; dots reach nested relations, as in `account_relations.account`.
`order-by`	string	Fields to sort by, comma-separated. A leading - sorts descending, as in `-modified`; dotted paths sort by related fields.
`filter`	object	`filter[field]=value`. Separate several values with a raw comma (OR), as in `filter[name]=north,south`. Encode a comma that belongs to a value as %2C. URLSearchParams and Python requests encode every comma, so build the filter part of the query string yourself. Dotted paths filter on related records, as in `filter[owner.email]`. Encode a + in a value as %2B: query values are form-decoded, so a raw + becomes a space.
`filter-op`	object	`filter-op[field]=operator`, one per field: eq (the default), ieq, not-eq, not-ieq, contains, icontains, starts, istarts, ends, iends, gt, gte, lt, lte, between, null, not-null, empty and not-empty. null, not-null, empty and not-empty take no filter value; gt, gte, lt and lte take exactly one.
`load-only`	string	Fields to return, comma-separated (raw or encoded commas both work here); dots select nested fields, as in `owner.id`. All fields are returned without it. Lists only: get-by-id refuses it with HTTP 400, code 118.

Responses

200 Page of Client records.: success, total, page_info, data 400 Bad request 401 Not authenticated 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Clients?first=10&filter%5Bname%5D=north&filter-op%5Bname%5D=icontains' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Clients?first=10&filter%5Bname%5D=north&filter-op%5Bname%5D=icontains', {
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`)
  }
})

import os

import requests

response = requests.get(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Clients",
    params={
      "first": "10",
      "filter[name]": "north",
      "filter-op[name]": "icontains"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"])
)

POST Create Client

Creates one record and answers 201 with it.

Query parameters

Name	Type	Description
`validation-level`	integer	Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

The new record's fields. Relations are set by id. Schema createClientInput; the fields are in Client fields. Required: default_unit_id, email, master_right_id, unit_membership.

Responses

201 The created Client record.: success, data 400 Bad request 401 Not authenticated 422 Validation failed 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Clients' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{
  "default_unit_id": "f2000000-0000-4000-a000-000000000001",
  "email": "northwind@example.com",
  "master_right_id": "6c000000-0000-4000-a000-000000000001",
  "unit_membership": []
}'

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Clients', {
  method: 'POST',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    default_unit_id: 'f2000000-0000-4000-a000-000000000001',
    email: 'northwind@example.com',
    master_right_id: '6c000000-0000-4000-a000-000000000001',
    unit_membership: []
  })
})

import os

import requests

response = requests.post(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Clients",
    headers={
      "Content-Type": "application/json"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
    json={
      "default_unit_id": "f2000000-0000-4000-a000-000000000001",
      "email": "northwind@example.com",
      "master_right_id": "6c000000-0000-4000-a000-000000000001",
      "unit_membership": []
    }
)

GET Get Client

Returns one record by id. expand returns related records inline instead of their URIs.

Path parameters

Name	Type	Description
`id`	string (uuid)	Id of the Client record to retrieve. Required

Query parameters

Name	Type	Description
`expand`	string	Related records to return inline instead of their URIs, comma-separated; dots reach nested relations. The only parameter this call accepts.

Responses

200 The Client record.: success, data 400 Bad request 401 Not authenticated 404 Not found 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Clients/37000000-0000-4000-a000-000000000001' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Clients/37000000-0000-4000-a000-000000000001', {
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`)
  }
})

import os

import requests

response = requests.get(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Clients/37000000-0000-4000-a000-000000000001",
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"])
)

PATCH Update Client

Changes the fields you send and leaves the rest as they are; there is no PUT.

Path parameters

Name	Type	Description
`id`	string (uuid)	Id of the Client record to update. Required

Query parameters

Name	Type	Description
`validation-level`	integer	Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

The fields to change. Schema updateClientInput; the fields are in Client fields.

Responses

200 The changed Client record.: success, data 400 Bad request 401 Not authenticated 404 Not found 422 Validation failed 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Clients/37000000-0000-4000-a000-000000000001' \
  --request PATCH \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{
  "default_unit_id": "f2000000-0000-4000-a000-000000000001"
}'

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Clients/37000000-0000-4000-a000-000000000001', {
  method: 'PATCH',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    default_unit_id: 'f2000000-0000-4000-a000-000000000001'
  })
})

import os

import requests

response = requests.patch(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Clients/37000000-0000-4000-a000-000000000001",
    headers={
      "Content-Type": "application/json"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
    json={
      "default_unit_id": "f2000000-0000-4000-a000-000000000001"
    }
)

DEL Delete Client

Deletes one record and answers with its id.

Path parameters

Name	Type	Description
`id`	string (uuid)	Id of the Client record to delete. Required

Responses

200 Deletion confirmation.: success, data 400 Bad request 401 Not authenticated 404 Not found 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Clients/37000000-0000-4000-a000-000000000001' \
  --request DELETE \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Clients/37000000-0000-4000-a000-000000000001', {
  method: 'DELETE',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`)
  }
})

import os

import requests

response = requests.delete(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Clients/37000000-0000-4000-a000-000000000001",
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"])
)

POST Create or update Clients in a batch

An item with an id updates that record; an item without one creates a record. By default one invalid item fails the whole call with HTTP 422 and nothing is written; with rollback-method=1 the response has an id or an error for each item, in input order.

Query parameters

Name	Type	Description
`validation-level`	integer	Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.
`rollback-method`	integer	0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item.

Request body

A JSON array of records: an item with an id updates, an item without one creates. Schema batchClientInput; the fields are in Client fields. Required: default_unit_id, email, master_right_id, unit_membership.

Responses

200 Result per item, in request order: the id of the created or updated record, or the error.: success, data 400 Bad request 401 Not authenticated 422 Validation failed 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Clients/batch-modify' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "default_unit_id": "f2000000-0000-4000-a000-000000000001",
    "email": "northwind@example.com",
    "master_right_id": "6c000000-0000-4000-a000-000000000001",
    "unit_membership": []
  },
  {
    "id": "37000000-0000-4000-a000-000000000001",
    "default_unit_id": "f2000000-0000-4000-a000-000000000001"
  }
]'

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Clients/batch-modify', {
  method: 'POST',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify([
    {
      default_unit_id: 'f2000000-0000-4000-a000-000000000001',
      email: 'northwind@example.com',
      master_right_id: '6c000000-0000-4000-a000-000000000001',
      unit_membership: []
    },
    {
      id: '37000000-0000-4000-a000-000000000001',
      default_unit_id: 'f2000000-0000-4000-a000-000000000001'
    }
  ])
})

import os

import requests

response = requests.post(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Clients/batch-modify",
    headers={
      "Content-Type": "application/json"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
    json=[
      {
        "default_unit_id": "f2000000-0000-4000-a000-000000000001",
        "email": "northwind@example.com",
        "master_right_id": "6c000000-0000-4000-a000-000000000001",
        "unit_membership": []
      },
      {
        "id": "37000000-0000-4000-a000-000000000001",
        "default_unit_id": "f2000000-0000-4000-a000-000000000001"
      }
    ]
)

POST Delete Clients in a batch

Deletes the records whose ids are in the body, a JSON array. By default an unknown id fails the whole call with HTTP 404.

Query parameters

Name	Type	Description
`rollback-method`	integer	0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item.

Request body

A JSON array of ids.

Responses

200 Result per id, in request order: the id of the deleted record, or the error.: success, data 400 Bad request 401 Not authenticated 404 Not found 422 Validation failed 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Clients/batch-delete' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  "37000000-0000-4000-a000-000000000001",
  "37000000-0000-4000-a000-000000000002"
]'

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Clients/batch-delete', {
  method: 'POST',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(['37000000-0000-4000-a000-000000000001', '37000000-0000-4000-a000-000000000002'])
})

import os

import requests

response = requests.post(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Clients/batch-delete",
    headers={
      "Content-Type": "application/json"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
    json=[
      "37000000-0000-4000-a000-000000000001",
      "37000000-0000-4000-a000-000000000002"
    ]
)

POST Restore deleted Clients

Restores the deleted records whose ids are in the body, a JSON array.

Query parameters

Name	Type	Description
`rollback-method`	integer	0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item.

Request body

A JSON array of ids.

Responses

200 Result per id, in request order: the id of the restored record, or the error.: success, data 400 Bad request 401 Not authenticated 404 Not found 422 Validation failed 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Clients/batch-restore' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  "37000000-0000-4000-a000-000000000001",
  "37000000-0000-4000-a000-000000000002"
]'

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Clients/batch-restore', {
  method: 'POST',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(['37000000-0000-4000-a000-000000000001', '37000000-0000-4000-a000-000000000002'])
})

import os

import requests

response = requests.post(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Clients/batch-restore",
    headers={
      "Content-Type": "application/json"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
    json=[
      "37000000-0000-4000-a000-000000000001",
      "37000000-0000-4000-a000-000000000002"
    ]
)

Client fields

Field	Type	Notes
`id`	uuid	Read-only Unique identifier of entity.
`default_unit_id`	uuid → SalesUnits	Required on create Id of the default sales unit.
`email`	string	Required on create Email.
`master_right_id`	uuid → MasterRights	Required on create Id of the assigned user role.
`unit_membership`	array of uri → SalesUnitClientRelations	Required on create Sales units the user belongs to (as member or manager).
`position`	string	Job title or position of the user.
`type`	integer	Kind of user: a regular Customer user, a Coevera Support user, or a Placeholder demo user that becomes a Customer when reassigned to a real person.0 Customer · 1 Support · 2 Placeholder
`revision`	integer	Revision when entity was lastly changed.
`appointment_favorite`	array of uri → ClientFavorites	Appointments marked as favorite by the user.
`task_favorite`	array of uri → ClientFavorites	Tasks marked as favorite by the user.
`account_favorite`	array of uri → ClientFavorites	Accounts marked as favorite by the user.
`contact_favorite`	array of uri → ClientFavorites	Contacts marked as favorite by the user.
`profile_favorite`	array of uri → ClientFavorites	Screen profiles marked as favorite by the user.
`report_favorite`	array of uri → ClientFavorites	Reports marked as favorite by the user.
`lead_favorite`	array of uri → ClientFavorites	Leads marked as favorite by the user.

Show all 38 fields

Field	Type	Notes
`opportunity_favorite`	array of uri → ClientFavorites	Opportunities marked as favorite by the user.
`is_delete_protected`	boolean	Read-only True when the record is protected against deletion because it must always exist in the space.
`is_deleted`	boolean	Read-only Specifies if the entity is considered deleted.
`modified`	date-time	Read-only Last modification time.
`created`	date-time	Read-only Creation time.
`default_unit`	uri → SalesUnits	Read-only Default sales unit for the user.
`master_right`	uri → MasterRights	Read-only User role assigned to the user.
`first_name`	string	Read-only First name.
`last_active`	date-time	Read-only Timestamp of the user's most recent login or API request.
`last_name`	string	Read-only Last name.
`middle_name`	string	Read-only Middle name.
`phone`	string	Read-only Phone number.
`picture_url`	string	Read-only Picture name.
`region`	string	Read-only Region.
`timezone`	string	Read-only Deprecated time zone offset of the user, copied from the user profile; read-only.
`default_idp`	integer	Read-only Id of the identity provider the user signs in with by default.
`user_profile_id`	integer	Read-only Id of the user account (login identity) this user belongs to.
`timezone_name`	string	Read-only IANA time zone name of the user (e.g.
`name`	string	Read-only Display name of the user, formatted according to the user's name format preference.
`formatted_name`	string	Read-only Display name of the user (alias of name).
`unit_manager_ids`	array of uuid	Read-only Ids of all sales units the user manages, expanded to include all descendant units in each managed subtree.
`unit_member_ids`	array of uuid	Read-only Ids of sales units the user belongs to as a member only (not as a manager).
`user_recalculation_state`	string	Read-only State of the user's row-level access recalculation: NoRecalculation (up to date), Pending (queued), or InProgress.InProgress · NoRecalculation · Pending

Custom fields appear in your space's live spec: fetch it with your credentials.

Errors

Every error body has success: false, http_status, code, name and message. Branch on code: the status alone does not tell a missing permission from a bad parameter. All codes: error codes; how to handle them: Errors.

HTTP	When
400	Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`.
401	Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED).
404	No such record or entity (code 143 ERROR_NO_ENTITY, or 2006 ERROR_UNKNOWN_TYPE).
422	Validation failed (code 40000, with the failing fields) or a required parameter is missing (code 119). By default one failed item fails a whole batch and nothing is written.
429	Too many requests (code 182). Wait for the seconds in Retry-After, then retry.
500	Unexpected server error (code 1000, ERROR_UNKNOWN).