API Reference
Start typing to search…

Get client

get https://api.mollie.com/v2/clients/

Retrieve a single client by its ID.

🔑

Access with

Access token with clients.read

Path Params
string
required

Provide the ID of the item you want to perform this operation on.

Query Params
string | null

This endpoint allows embedding related API items by appending the following values via the embed query string parameter.

  • organization: Include the organization of the client. Available for signuplink partners, or for oauth partners with the organizations.read scope.
  • onboarding: Include the onboarding status of the client. Available for signuplink partners, or for oauth partners with the onboarding.read scope.
  • capabilities: Include the capabilities of the client organization. Available for oauth partners with the onboarding.read scope.
Responses

Response body
object
string
Defaults to client

Indicates the response contains a client object. Will always contain the string client for this resource type.

string

The identifier uniquely referring to this client. Example: org_12345678.

object | null

The commission object.

integer

The commission count.

string

The date and time the client organization was created, in ISO 8601 format.

_links
object

An object with several relevant URLs. Every URL object will contain an href and a type field.

self
object

In v2 endpoints, URLs are commonly represented as objects with an href and type field.

organization
object

The API resource URL of the client's organization.

onboarding
object

The API resource URL of the client's onboarding status.

documentation
object

In v2 endpoints, URLs are commonly represented as objects with an href and type field.

_embedded
object
organization
object
onboarding
object
capabilities
object

Updated 6 months ago

Did this page help you?
Language
Credentials
OAuth2
Request

Updated 6 months ago

Did this page help you?