PApactima
Members

List all members

List all members that are part of the specified team

get/teams/{teamId}/members

Request

  • Base URL
    https://rest.api.pactima.com/v1
  • URL
    https://rest.api.pactima.com/v1/teams/{teamId}/members
  • Auth
    HTTP bearer

Query parameters

searchTermstring

Search term to filter members by name or email

rolesTeamMemberSpecialRoleEnum[]

Filter members by multiple roles

namestring

Filter members by name (partial match)

emailstring

Filter members by email address (partial match)

notaryPublicProfilestring

JSON-encoded filter object. The controller parses the value with JSON.parse and matches members whose notaryPublicProfile field equals (or partially equals) the given properties. Example: { "jurisdiction.state": "TX" }.

hasNotaryPublicProfileboolean

Filter members by whether they have a notary public profile (true) or not (false)

sortBy'name' | 'email' | 'userId'

Field to sort members by

sortOrder'asc' | 'desc'

Sort order (ascending or descending)

limitnumber

Limit on number of objects returned. Default to 100. Maximum 100.

skipnumber

The cursor pagination for the number at which at the returned array starts. Must be less than maximum of elements.

Response

A directory with a data property that contains an array of up to limit objects, starting after skip. Each entry in the array is a separate object. If no more objects are available, the resulting array will be empty. This request should never return an error.

hasMoreboolean

Changes

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