Developers
Diamonds18

List memberships

GET/automations/diamond/{diamond_id}/memberships

Returns the leads in a Diamond, paginated by cursor. The collection can be filtered by user, stage, and last update time.

Credentials scoped to specific users only see the memberships of those users.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

diamond_id*string

Public ID of the diamond, prefixed with dmd_.

Query Parameters

limit?integer

Maximum number of items to return, from 1 to 200.

Range1 <= value <= 200
cursor?string

Cursor for the next page, taken from page.next_cursor of the previous response.

sort?string

Sort order. A leading - sorts in descending order.

Value in

  • "id"
  • "-id"
user_id?string

Only memberships of the user with this public ID.

stage_id?string

Only memberships currently in this stage.

updated_after?string

Only items updated after this date and time (ISO 8601).

Formatdate-time

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/automations/diamond/string/memberships"
{  "data": [    {      "created_at": "2019-08-24T14:15:22Z",      "diamond_id": "string",      "enrollment_id": "string",      "id": "string",      "last_run": {        "at": "2019-08-24T14:15:22Z",        "error": "string",        "status": "failed"      },      "object": "membership",      "pending": {        "next_check_at": "2019-08-24T14:15:22Z",        "queued_events": 0      },      "progress": {        "confirmed_stages": [          "string"        ]      },      "revision": "string",      "stage_id": "string",      "stage_position": 0,      "updated_at": "2019-08-24T14:15:22Z",      "user_id": "string"    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Delete a Diamond DELETE

Moves the Diamond to the trash. A Diamond that still has memberships cannot be deleted, and deletion cannot be forced. Such requests return the `state_conflict` error code.

Create a membership POST

Adds a user to the Diamond as a lead, starting at the `lead` stage. A new membership also grants the user access to the Diamond's internal delivery and schedules the communication for the `lead` stage. If the user is already a member of this Diamond, the existing membership is returned and no communication is sent again. A user can belong to only one Diamond at a time. In addition to `diamonds.manage_memberships`, this operation requires the `enrollments.create` permission.