Passer au contenu
/
📋 Get all clients

📋 Get all clients

Requête

Get all clients with their details.

Optionally filter by external_ref to find a specific client.

Sécurité
APIKeyHeader
Requête
external_refstring or null(External Ref)
Any of:
string
curl -i -X GET \
  'https://pdp.seqino.dev/api/clients?external_ref=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Réponses

List of all clients, or client matching external_ref if provided

Corpsapplication/json
Any of:
Array [
[].​client_idstring(Client Id)

Unique client identifier

[].​organization_namestring(Organization Name)obligatoire

Name of the organization

[].​contact_emailstring(Contact Email)obligatoire

Contact email for the organization

[].​external_refstring(External Ref)obligatoire

External reference identifier

[].​sponsor_idstring(Sponsor Id)obligatoire

PDP sponsor ID from the X-PDP-Sponsor-Id header

[].​statusstring(ClientStatus)obligatoire

Current status of the client

Enum:"active""inactive""pending""suspended"
[].​created_atstring, (date-time)(Created At)obligatoire

When the client was created

[].​updated_atstring or null(Updated At)
Any of:

When the client was last updated

string (date-time)
]
Response
[
  {
    "client_id": "string",
    "organization_name": "string",
    "contact_email": "string",
    "external_ref": "string",
    "sponsor_id": "string",
    "status": "active",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
]