List provider participants

GET
/providers/{providerID}/participants

List your participants, newest first. Returns an empty list when none exist.

Pagination is cursor-based. Omit cursor to fetch the first page; use nextCursor from each response to fetch the next page.

Auth: API key or bearer token. Scoped to the calling provider.

Request
cURL
curl -X GET https://api.moov.money/providers/{providerID}/participants
Responses
200 400 401
The request completed successfully.
{
  "participants": [
    {
      "address": {
        "addressLine1": "123 Main St",
        "addressLine2": "Apt 4B",
        "city": "San Francisco",
        "country": "US",
        "postalCode": "94105",
        "stateOrProvince": "CA"
      },
      "createdOn": "2026-08-31T12:00:00Z",
      "emails": [
        {
          "createdOn": "2026-08-31T12:00:00Z",
          "email": "[email protected]"
        }
      ],
      "familyName": "Smith",
      "givenName": "Jane",
      "limitGroups": [
        {
          "groupID": "grp_01HF5J9ZKQT4RXP8M2VYBN3D",
          "name": "Premium"
        }
      ],
      "moovAccountID": "acc_01HF5J9ZKQT4RXP8M2VYBN3D",
      "participantID": "usr_01HF5J9ZKQT4RXP8M2VYBN3D",
      "phones": [
        {
          "createdOn": "2026-08-31T12:00:00Z",
          "phone": {
            "countryCode": "1",
            "number": "5555550101"
          }
        }
      ],
      "status": "active",
      "updatedOn": "2026-08-31T12:00:00Z"
    }
  ]
}
Malformed request: the body or headers failed validation.
Authentication missing, invalid, or insufficient.

Headers

X-Moov-Version

string
Set this header to the API version being targeted (e.g. v2026.07.00). When omitted, the server applies its default version.

Path parameters

providerID

string required
Your provider account ID.

Query parameters

cursor

string
Opaque pagination cursor from a previous response’s nextCursor. Omit to fetch the first page.

limit

integer <int32>
Maximum number of participants to return. Defaults to 25; values outside 1-100 return 400.

Response

Response envelope for list participants.

nextCursor

string
Opaque cursor for the next page; absent on the last page.

hasMore

boolean required
Whether another page of results follows this one.

participants

array<object> required
The page of participants, newest first.
Show child attributes

participants[]

address

object
Participant’s primary postal address. Omitted when none was provided at creation.
Show child attributes

participants[].address

addressLine2

string
Second line of the street address (apartment, suite, etc.).

city

string required
City / locality.

stateOrProvince

string required
State, province, or region.

postalCode

string required
Postal / ZIP code.

country

string required
ISO 3166-1 alpha-2 country code.

addressLine1

string required
First line of the street address.

createdOn

string<date-time>
When this participant was created.

dateOfBirth

string<date>
Participant’s date of birth, YYYY-MM-DD. Omitted when not provided at creation.

disabledOn

string<date-time>
When this participant was disabled. Omitted while active.

emails

array<object>
Show child attributes

participants[].emails[]

createdOn

string<date-time>
When this email was added.

disabledOn

string<date-time>
When this email was disabled.

email

string
Email address.

verifiedOn

string<date-time>
When the participant confirmed ownership of this email.

familyName

string
Participant’s family (last) name.

givenName

string
Participant’s given (first) name.

limitGroups

array<object>
Limit groups this participant belongs to. Empty when the participant belongs to no group.
Show child attributes

participants[].limitGroups[]

groupID

string
Identifier of the limit group.

name

string
Display name of the limit group.

middleName

string
Participant’s middle name or middle initial.

moovAccountID

string
Moov account ID linked to this participant. Set for sending participants once they have a linked Moov account; omitted until then.

nickName

string
Name the participant goes by, for example Bob for Robert.

participantID

string
Unique identifier for this participant.

phones

array<object>
Show child attributes

participants[].phones[]

createdOn

string<date-time>
When this phone number was added.

disabledOn

string<date-time>
When this phone number was disabled.

phone

object
Phone on this record.
Show child attributes

participants[].phones[].phone

number

string required
National significant number without the country calling code. ASCII digits only.

countryCode

string required
ITU country calling code without a leading plus. ASCII digits only.

verifiedOn

string<date-time>
When the participant confirmed ownership of this phone number.

status

string<enum>
Current lifecycle status of the participant.
Possible values: active, disabled, pending, denied

updatedOn

string<date-time>
When this participant was last updated.