List your clients

GET

/partner/clients

const url = 'https://api.europlaybook.com/v1/partner/clients?limit=50';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.europlaybook.com/v1/partner/clients?limit=50' \
  --header 'Authorization: Bearer <token>'

Client accounts of your partner that are not revoked: status invited (the owner has not accepted yet) or active, with the open owner invite and the last activity. Cursor pagination.

Authorizations

BearerTokenAuth

Parameters

Query Parameters

cursor

Any of:

string
null

string

Opaque cursor from next_cursor of the previous page.

limit

Limit

Items per page (1-200).

integer

default: 50 >= 1 <= 200

Items per page (1-200).

Any of:

string
null

string

Responses

200

application/json

ClientCursorPage

object

items

required

Items

Array<object>

ClientOut

object

required

The client’s account id (send it as EuroPlaybook-Account)

string format: uuid

account_id

required

Account Id

string format: uuid

name

required

Name

string

status

required

Status

Invited = the owner has not accepted yet; active = joined

string

Allowed values: invited active

owner_email

required

Owner Email

string

owner_joined

required

Owner Joined

boolean

accepted_at

required

Any of:

string
null

string format: date-time

created_at

required

Created At

string format: date-time

company

Any of:

ClientCompanyOut
null

ClientCompanyOut

object

name

required

Name

string

country

required

Country

string

owner_invite

Any of:

OwnerInviteOut
null

OwnerInviteOut

object

email

required

Email

string

sent_at

required

Sent At

string format: date-time

expires_at

required

Expires At

string format: date-time

expired

required

Expired

boolean

last_activity_at

Any of:

string
null

string format: date-time

next_cursor

required

Any of:

string
null

string

Example

{
  "items": [
    {
      "status": "invited"
    }
  ]
}

400

Bad Request

application/json

PublicErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object
null

object

key

additional properties

any

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  }
}

401

Unauthorized

application/json

PublicErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object
null

object

key

additional properties

any

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  }
}

403

Forbidden

application/json

PublicErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object
null

object

key

additional properties

any

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  }
}

404

Not Found

application/json

PublicErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object
null

object

key

additional properties

any

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  }
}

409

Conflict

application/json

PublicErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object
null

object

key

additional properties

any

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  }
}

422

Unprocessable Content

application/json

PublicValidationErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object
null

object

key

additional properties

any

errors

Errors

Per-field problems (pydantic format: loc, msg, type).

Array<object>

default:

object

key

additional properties

any

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  },
  "errors": []
}

429

Too Many Requests

application/json

PublicErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object
null

object

key

additional properties

any

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  }
}