v1
latestOpenAPI 3.1.02026-07-24770322.0 KBList Clients
This API endpoint retrieves a list of clients. <br><br>You can use the query params to filter a subset of clients who match specific field values.
get/v1/clients
Query parameters
companyIdstring
Any of the company IDs of the client user(s) to query for.
emailstring
The email of the client user to query for (exact match, case-sensitive).
givenNamestring
The given name of the client user(s) to query for (exact match, case-sensitive).
familyNamestring
The family name of the client user(s) to query for (exact match, case-sensitive).
nextTokenstring
limitinteger
Response
200
Example response
{
"data": [
{
"id": "b341c3e8-d991-4647-8839-337b2a7f792d",
"object": "client",
"createdAt": "2024-01-26T23:21:26.877676074Z",
"givenName": "Sample",
"familyName": "Client1",
"email": "client1@copilot.app",
"companyId": "08a168a4-2c97-441e-8373-f8cd49c79241",
"companyIds": [
"08a168a4-2c97-441e-8373-f8cd49c79241"
],
"status": "notInvited",
"inviteUrl": "https://productiondemo.copilot.app/u/jiDAQ4tSR",
"fallbackColor": "#938EAB",
"creationMethod": "directSignUp"
}
],
"nextToken": "eyJwa2V5IjoiODc2NjdkY2ItNjcxNC00ZmNkLWJjNGUtNDI0ZGUxMzNiZjYyIiwic2tleSI6IkNMSUVOVF9DT01QQU5ZIiwiZGF0YSI6InVzLWVhc3QtMV9xbEFSQlE5bUYvZGVmYXVsdC9iMTRlZmJlOC03Y2U3LTRjNDEtYTdhNC0yMzczMTNmYzgxZDMifQ=="
}