Platform

List the people in the organisation

Who is in the organisation: name, email, role, whether they are still active, and which teams they belong to, ordered by email. detailed adds each member’s permission grants and how they sign in, and returns them ONLY to an organisation admin — anybody else gets permissions: null, which means «not visible to you» and never «holds nothing». It answers «chi è Mario» and gives you the user_id the CRM and workflow tools take as an owner or assignee; it is not a way to build a mailing list.

Examples

  • Chi lavora in questa organizzazione? GET /api/v1/rest/members
  • Who are the admins? GET /api/v1/rest/members?role=admin
  • Find Mario GET /api/v1/rest/members?query=mario
  • What can Mario actually do in here? GET /api/v1/rest/members?query=mario&response_format=detailed
get/api/v1/rest/members

Request

  • Base URL: https://api.custodo.ai
  • URL: https://api.custodo.ai/api/v1/rest/members
  • Auth: HTTP bearer

Query parameters

querystring

Match on full name or email, at least two characters. Omit for everybody.

role'admin' | 'user'

admin holds every permission; user holds only what an admin granted.

status'active' | 'revoked' | 'any'

revoked is somebody who can no longer sign in. Default: the active members only.

limitinteger

Rows to return, 1–100. Default 100: an organisation has tens of members, and there is no cursor.

response_format'concise' | 'detailed'

concise (default) returns the fields you need to answer a question; detailed adds related records and costs more context.

Headers

X-Tenant-Idstring uuid

The organisation to act in. An API key is bound to exactly one, so this is optional for a key and must match the one it was minted for.

Response

Done. data is the tool’s own answer.

oktrue required
dataunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.