Cowdidocs
API ReferenceProfile

Get the caller's user record

GET
/v1/user

Returns the caller's user record. The response includes the caller's profile email and phone contacts, and suspension details when status is SUSPENDED. A user token calls this on behalf of the signed-in user.

Authorization

oauth2
AuthorizationBearer <token>

Create a client with POST /v1/oauth/clients, then exchange its credentials for an access token. AUTHORIZATION_CODE clients act on behalf of a signed-in user and always use PKCE; CLIENT_CREDENTIALS clients act as themselves. A client may only be granted scopes its creator already holds — read the grantable list from GET /v1/oauth/clients/scopes.

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/user"
{  "id": "b50e8400-e29b-41d4-a716-446655440000",  "resource_id": "usr_5n1t201rmv87aae5j4csam8000",  "first_name": "John",  "last_name": "Doe",  "status": "ACTIVE",  "email": "john.doe@example.com",  "email_verified": true,  "phone_number": "+254712345678",  "emails": [],  "phone_numbers": [],  "tag": "@johnd1234",  "locale": "en-KE",  "timezone": "Africa/Nairobi",  "last_login_at": "2026-02-03T10:15:30Z",  "avatar_options": "seed=k3f9x2&skinColor=edb98a"}
{  "code": "BAD_REQUEST",  "description": "Bad Request"}
{  "code": "UNAUTHORISED",  "description": "Unauthorised"}
{  "code": "FORBIDDEN",  "description": "Forbidden"}
{  "code": "RATE_LIMIT_EXCEEDED",  "description": "Too Many Requests"}
{  "code": "INTERNAL_ERROR",  "description": "Internal Server Error"}

Delete an organization's brand DELETE

Removes the brand for `organizationId`. Requires a WorkOS bearer token whose `cowdi_org_id` matches `organizationId`, plus the `org:branding:write` permission (override with BRANDING_WRITE_PERMISSION). Returns 404 when the organization has no brand.

Set the caller's avatar PUT

Sets the caller's avatar customisation, or clears it when `options` is null. The value is an opaque query string the client appends to its avatar style URL. A user token calls this on behalf of the signed-in user. Returns the caller's updated user record.