Skip to main content

Client

Who the credentials belong to. The call is token-scoped: one credential pair maps to exactly one company, so there is no id or owner parameter to pass anywhere.

get_my_client​

Fetches the identity and permissions of the company behind the current credentials.

Signature​

def get_my_client(self) -> ClientResponse:

Parameters​

None β€” the call is token-scoped.

Returns​

ClientResponse:

FieldTypeDescription
clientOptional[ClientInfo]Identity and permissions of the token-scoped company.
fundingOptional[Dict[str, Any]]Provider-specific, passed through as a raw dict β€” not part of the SDK's typed contract.

ClientInfo:

FieldTypeDescription
idOptional[str]Company id.
clientOptional[str]Client identifier used by the platform.
nameOptional[str]Display name.
is_activeboolWhether the company is active.
permissionsOptional[List[str]]Granted permissions.

Example​

me = client.get_my_client()
print(me.client.name, me.client.is_active, me.client.permissions)

Errors​

Notes​

  • Use this as the "is my client wired up correctly" check before doing anything else β€” see the overview.

API reference​

No public API reference page exists for /me/client β€” it isn't part of the generated reference.