Get a client

GET

/partner/clients/{client_id}

curl --request GET \
  --url https://api.europlaybook.com/v1/partner/clients/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

• Production

client_id is the client’s account id. 404 when it is not a live client of your partner.

Authorizations

• BearerTokenAuth

Parameters

Path Parameters

client_id

required

Client Id

string format: uuid

Responses

200

OK

Media typeapplication/json

ClientOut

object

id

required

Id

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

string format: date-time

null

null

created_at

required

Created At

string format: date-time

company

Any of:

ClientCompanyOut

ClientCompanyOut

object

name

required

Name

string

country

required

Country

string

null

null

owner_invite

Any of:

OwnerInviteOut

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

null

null

last_activity_at

Any of:

string

string format: date-time

null

null

Example

{
  "status": "invited"
}

400

Bad Request

Media typeapplication/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

object

key

additional properties

any

null

null

Example

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

401

Unauthorized

Media typeapplication/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

object

key

additional properties

any

null

null

Example

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

403

Forbidden

Media typeapplication/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

object

key

additional properties

any

null

null

Example

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

404

Not Found

Media typeapplication/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

object

key

additional properties

any

null

null

Example

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

409

Conflict

Media typeapplication/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

object

key

additional properties

any

null

null

Example

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

422

Unprocessable Content

Media typeapplication/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

object

key

additional properties

any

null

null

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

Media typeapplication/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

object

key

additional properties

any

null

null

Example

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