Skip to navigation

Retrieve a client

View as MarkdownOpen in Claude

Returns one client by id: its name, last name and company. Use it to check a client before you assign websites to it. A contact id answers 404.

Authentication

AuthorizationBearer

Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints.

Path parameters

client_idstringRequired

Query parameters

includestringOptional

Related data to return with the client. Accepted: contact_methods and sites. Separate several with commas.

fields[clients]stringOptional

Limits the attributes returned. sites_count, the number of websites your token can reach, is only returned when you name it here.

Response

200 - Client

dataobjectOptional
jsonapiobjectOptional

Errors

404
Not Found Error