Sign in
Sequences

Get a person's sequence enrollment status

Permission-safe summary of the Sequences a Person is currently enrolled in, including active count and the account's concurrent-enrollment limit. Requires a USER API key. Instances in a Sequence the caller cannot view are returned as { instanceId, restricted: true }.

get/public/v1/sequences/instances/person-status

Query parameters

personRowIdstring required
Example:example

Response

Person's sequence enrollment status

activeCountnumber required
maxAllowednumber required
allowMultipleActiveSequencesboolean required
canEnrollMoreboolean required
blockedCode'ACTIVE_SEQUENCE_CONFLICT' | 'MULTIPLE_SEQUENCES_DISABLED' | 'MAX_CONCURRENT_SEQUENCES_REACHED' nullable
blockedReasonstring nullable

Example response

{
  "instances": [
    {
      "instanceId": 1,
      "restricted": true
    }
  ],
  "activeCount": 1,
  "maxAllowed": 1,
  "blockedCode": "ACTIVE_SEQUENCE_CONFLICT",
  "blockedReason": "example"
}

Changes

Changed in 1 of the 2 revisions of this API.1