v1

latestOpenAPI 3.0.12026-07-245277551.2 MB

Profile

List all profiles across all types

get/group-profile/v1/profiles

Query parameters

profileIdsinteger[]

Filter profiles by specific IDs (comma-separated list)

statusProfileStatus[]

Filter by profile status

[
  "ACTIVE"
]

profileTypeProfileType[]

Filter by profile types (supports multiple selections)

namestring

Filter profiles by name containing this text (case-insensitive partial match)

codestring

Filter profiles by code containing this text (case-insensitive partial match)

sortstring

Sort profiles by field and direction in format: field:direction Examples: name:asc, createdAt:desc, code:asc Valid fields: code, name, createdAt, updatedAt, profileType, status Valid directions: asc, desc Default: name:asc

pageTokenstring

Cursor token for pagination. Use the nextPageToken from the previous response to fetch the next page.

Usage:

Omit or pass empty string for the first page
Pass the nextPageToken from previous response for subsequent pages
When nextPageToken is null in the response, you've reached the last page

Benefits over offset-based pagination:

Consistent results even when data changes between requests
Better performance for large datasets (no row skipping)
No maximum page limit

limitinteger

Page size. Specifies the maximum number of items to return in a single response.

Limits:

Minimum: 1
Maximum: 500
Default: 100

Headers

x-property-idinteger

Property ID

x-organization-idinteger required

Organization ID

Response

List all profiles successfully

nextPageTokenstring nullable

Token to fetch the next page of results. Pass this value as the pageToken query parameter in the next request. When null, there are no more pages available.

Example response

{
  "data": [
    {
      "photoId": 12345,
      "taxId": "12345",
      "companyTaxId": "12345",
      "statusId": 12,
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "phone": "123456789",
      "cellPhone": "123456789",
      "birthday": "1970-01-01",
      "gender": "M",
      "companyName": "Company",
      "address1": "Address line 1",
      "address2": "Address line 2",
      "city": "City",
      "country": "US",
      "countryName": "United States",
      "state": "State",
      "zip": "12345",
      "documentType": "driver_licence",
      "documentNumber": "123456789",
      "documentIssueDate": "1970-01-01",
      "documentIssuingCountry": "US",
      "documentExpirationDate": "1970-01-01",
      "id": "123456788",
      "organizationId": "12345",
      "statusName": "VIP",
      "statuses": [
        {
          "id": 1,
          "name": "VIP"
        },
        {
          "id": 2,
          "name": "Regular"
        }
      ],
      "dateCreated": "2024-08-06T13:38:35+00:00",
      "dateModified": "2024-08-06T16:58:59+00:00",
      "dateAnonymized": "2024-08-06T16:58:59+00:00",
      "parentId": "123456789",
      "photo": {
        "fileId": "12345",
        "path": "https://amazonaws.com/photo-jumbo~~67816f854de79.jpg",
        "croppedImage": "https://amazonaws.com/photo-jumbo_thumb~~67816f857ccab.jpg",
        "height": 797,
        "width": 1000,
        "cropParam": {
          "width": 75.140625,
          "height": 75.140625,
          "x": 212.12890625,
          "y": 210.203125
        }
      },
      "isAnonymizationAvailable": true
    }
  ]
}