Skip to content
Hoursmith Docs
APIReferenceMembers

List members

GET
/members

Authorization

BearerAuth
AuthorizationBearer <token>

Personal Access Token. Mint at Settings → API. Token shape: hsk_<env>_<prefix12>_<secret32>.

In: header

Query Parameters

cursor?string

Opaque pagination cursor — nextCursor from a previous response.

limit?integer

Page size (1–200, default 50).

sort?string

Sort field, optionally prefixed with - for descending (Stripe-style). Defaults to -createdAt (newest first). The allowed fields differ per resource — see each list* operation. Common examples: ?sort=-paidAt (latest paid invoice), ?sort=dueDate (earliest due first), ?sort=name (alphabetical). Cursors are sort-aware: keep the same sort= when paginating. Allowed sort fields for members: createdAt, id, role.

search?string

Case-insensitive partial match on the related user's name / email. Joins through the relation — pair with other filters as needed.

role?string

One of: OWNER, ADMIN, MANAGER, MEMBER.

createdAtFrom?string

Inclusive lower bound on createdAt. Accepts YYYY-MM-DD (treated as UTC midnight) or full ISO timestamp.

createdAtTo?string

Inclusive upper bound on createdAt. YYYY-MM-DD is treated as end-of-day so the date is fully included.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/members"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "orgId": "25b2c2d5-a7fc-47d0-89e4-8709a1560bfa",      "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",      "role": "OWNER",      "name": "string",      "email": "user@example.com",      "createdAt": "2019-08-24T14:15:22Z"    }  ],  "pagination": {    "limit": 1,    "nextCursor": "string"  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string"  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string"  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string"  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string"  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string"  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string"  }}
Was this page helpful?