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:
| Field | Type | Description |
|---|---|---|
client | Optional[ClientInfo] | Identity and permissions of the token-scoped company. |
funding | Optional[Dict[str, Any]] | Provider-specific, passed through as a raw dict β not part of the SDK's typed contract. |
ClientInfo:
| Field | Type | Description |
|---|---|---|
id | Optional[str] | Company id. |
client | Optional[str] | Client identifier used by the platform. |
name | Optional[str] | Display name. |
is_active | bool | Whether the company is active. |
permissions | Optional[List[str]] | Granted permissions. |
Exampleβ
me = client.get_my_client()
print(me.client.name, me.client.is_active, me.client.permissions)
Errorsβ
B2B_COMPANY_NOT_FOUNDβ no company is associated with the credentials used.B2B_UNAUTHORIZEDβ bad token or bad request signature.
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.