Skip to main content
GET
/
identities
curl -X GET "https://YOUR_BLNK_INSTANCE_URL/identities?limit=20&offset=0" \
  -H "X-Blnk-Key: YOUR_API_KEY"

[
  {
    "identity_id": "idt_1234567890",
    "identity_type": "individual",
    "first_name": "John",
    "last_name": "Doe",
    "other_names": "",
    "gender": "male",
    "email_address": "john.doe@example.com",
    "phone_number": "+1234567890",
    "nationality": "US",
    "organization_name": "",
    "category": "individual",
    "street": "123 Main St",
    "country": "United States",
    "state": "California",
    "post_code": "90210",
    "city": "Beverly Hills",
    "dob": "1990-01-15T00:00:00Z",
    "created_at": "2024-01-15T10:30:00Z",
    "meta_data": {
      "customer_tier": "premium"
    }
  },
  {
    "identity_id": "idt_0987654321",
    "identity_type": "organization",
    "first_name": "",
    "last_name": "",
    "other_names": "",
    "gender": "",
    "email_address": "contact@acmecorp.com",
    "phone_number": "+1987654321",
    "nationality": "",
    "organization_name": "Acme Corporation",
    "category": "corporate",
    "street": "456 Business Ave",
    "country": "United States",
    "state": "New York",
    "post_code": "10001",
    "city": "New York",
    "dob": "0001-01-01T00:00:00Z",
    "created_at": "2024-01-20T14:22:00Z",
    "meta_data": {
      "business_type": "technology"
    }
  }
]
Retrieves a list of all identities in the system. Supports pagination and advanced filtering using query parameters.

​
Query Parameters

​
limit
integer
default:"20"
Maximum number of identities to return (1-100)
​
offset
integer
default:"0"
Number of identities to skip for pagination

​
Advanced Filtering

You can filter identities using query parameters in the format field_operator=value:
​
first_name_eq
string
Filter by exact first name match
​
category_in
string
Filter by category (comma-separated values for multiple options)Example: category_in=individual,corporate
​
created_at_gte
string
Filter by creation date (greater than or equal to)Example: created_at_gte=2024-01-01
​
created_at_lte
string
Filter by creation date (less than or equal to)Example: created_at_lte=2024-12-31

​
Supported Operators

  • eq - Equals
  • ne - Not equals
  • gt - Greater than
  • gte - Greater than or equal to
  • lt - Less than
  • lte - Less than or equal to
  • in - In list (comma-separated)
  • contains - Contains substring

​
Filterable Fields

  • identity_id
  • identity_type
  • first_name
  • last_name
  • email_address
  • phone_number
  • category
  • country
  • state
  • city
  • created_at

​
Response

Returns an array of identity objects.
​
identities
array
Array of identity objects
curl -X GET "https://YOUR_BLNK_INSTANCE_URL/identities?limit=20&offset=0" \
  -H "X-Blnk-Key: YOUR_API_KEY"

[
  {
    "identity_id": "idt_1234567890",
    "identity_type": "individual",
    "first_name": "John",
    "last_name": "Doe",
    "other_names": "",
    "gender": "male",
    "email_address": "john.doe@example.com",
    "phone_number": "+1234567890",
    "nationality": "US",
    "organization_name": "",
    "category": "individual",
    "street": "123 Main St",
    "country": "United States",
    "state": "California",
    "post_code": "90210",
    "city": "Beverly Hills",
    "dob": "1990-01-15T00:00:00Z",
    "created_at": "2024-01-15T10:30:00Z",
    "meta_data": {
      "customer_tier": "premium"
    }
  },
  {
    "identity_id": "idt_0987654321",
    "identity_type": "organization",
    "first_name": "",
    "last_name": "",
    "other_names": "",
    "gender": "",
    "email_address": "contact@acmecorp.com",
    "phone_number": "+1987654321",
    "nationality": "",
    "organization_name": "Acme Corporation",
    "category": "corporate",
    "street": "456 Business Ave",
    "country": "United States",
    "state": "New York",
    "post_code": "10001",
    "city": "New York",
    "dob": "0001-01-01T00:00:00Z",
    "created_at": "2024-01-20T14:22:00Z",
    "meta_data": {
      "business_type": "technology"
    }
  }
]

​
Pagination

Use limit and offset parameters to paginate through large result sets:
  • First page: ?limit=20&offset=0
  • Second page: ?limit=20&offset=20
  • Third page: ?limit=20&offset=40
For more complex filtering with sorting and total count, use the Filter Identities endpoint with a JSON request body.

​
Performance Notes

  • When no filters are provided, the endpoint uses a legacy method that retrieves all identities
  • When filters are present, an optimized filtered query is executed
  • For better performance with large datasets, use specific filters
See Also: Filter Identities, Get Identity

Build docs developers (and LLMs) love

Get started for freeTalk to us