/

Consumer Lookup (GET)

get

Looks up consumers based on the provided filter criteria using GET method

Authorizations

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Query parameters

serviceProviderIdintegerOptional

Service Provider ID

Example: 123

organizationIdintegerOptional

Organization ID

Example: 456

firstNamestringOptional

First Name

Example: John

lastNamestringOptional

Last Name

Example: Doe

birthDatestringOptional

Birth Date

Example: 1990-01-01

genderstringOptional

Gender

Example: Male

isPatientbooleanOptional

Is Patient

Example: true

isPrimarybooleanOptional

Is Primary

includeInActivebooleanOptional

Include Inactive

Example: true

inactivebooleanOptional

Inactive

emailstringOptional

Example: [email protected]

mobileNumberstringOptional

Mobile Number

Example: 1234567890

archivedbooleanOptional

Archived

Example: true

namestringOptional

Name

Example: Sample Name

pageNumberstringOptional

Page Number

Example: 1

pageSizestringOptional

Page Size

Example: 10

sortByobjectOptional

Sort By

Example: {"field":"firstName","order":"asc"}

Responses

200Success

application/json

get

/api/consumer-lookup/

GET /api/consumer-lookup/ HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "id": 1,
    "organizationId": 123,
    "externalId": "ext-12345",
    "consumerUuid": "550e8400-e29b-41d4-a716-446655440000",
    "authenticationId": "auth-12345",
    "firstName": "John",
    "lastName": "Doe",
    "timeZone": "GMT",
    "birthDate": "1990-01-01",
    "createdAt": "2023-01-01",
    "gender": "Male",
    "email": "[email protected]",
    "mobileNumber": "+1234567890",
    "guardianId": 2,
    "guardian": [],
    "addressLine1": "123 Main St",
    "addressLine2": "Apt 4B",
    "city": "New York",
    "state": "NY",
    "zipCode": "10001",
    "currency": "USD",
    "country": "USA",
    "isPrimary": true,
    "isPatient": true,
    "relationship": [],
    "relationshipType": "SELF",
    "dependants": [],
    "idProof": {},
    "insuranceDetails": {},
    "attributes": {},
    "addresses": [],
    "externalConsumer": [],
    "lastLoginAt": "2023-01-01",
    "active": true,
    "profilePicFileId": 3,
    "profilePictureCloudId": "cloud-12345",
    "profilePicture": "http://example.com/profile.jpg",
    "isWelcomeEmailSent": true,
    "forwardRelationship": [],
    "referrals": {},
    "recordSource": "INTERNAL",
    "populationTagIds": [],
    "populationTags": [],
    "tagsToAdd": [],
    "tagsToRemove": [],
    "wallets": {},
    "careTeams": [],
    "relatedConsumerId": 2
  }
]

Consumer Lookup (POST)

post

Looks up consumers based on the provided filter criteria using POST method

Authorizations

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Body

serviceProviderIdintegerOptional

Service Provider ID

Example: 123

organizationIdintegerOptional

Organization ID

Example: 456

firstNamestringOptional

First Name

Example: John

lastNamestringOptional

Last Name

Example: Doe

birthDatestringOptional

Birth Date

Example: 1990-01-01

genderstringOptional

Gender

Example: Male

isPatientbooleanOptional

Is Patient

Example: true

isPrimarybooleanOptional

Is Primary

includeInActivebooleanOptional

Include Inactive

Example: true

inactivebooleanOptional

Inactive

emailstringOptional

Example: [email protected]

mobileNumberstringOptional

Mobile Number

Example: 1234567890

archivedbooleanOptional

Archived

Example: true

namestringOptional

Name

Example: Sample Name

pageNumberstringOptional

Page Number

Example: 1

pageSizestringOptional

Page Size

Example: 10

sortByobjectOptional

Sort By

Example: {"field":"firstName","order":"asc"}

Responses

200Success

application/json

post

/api/consumer-lookup/

POST /api/consumer-lookup/ HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 369

{
  "serviceProviderId": 123,
  "organizationId": 456,
  "firstName": "John",
  "lastName": "Doe",
  "birthDate": "1990-01-01",
  "gender": "Male",
  "isPatient": true,
  "isPrimary": true,
  "includeInActive": true,
  "inactive": true,
  "email": "[email protected]",
  "mobileNumber": "1234567890",
  "archived": true,
  "name": "Sample Name",
  "pageNumber": "1",
  "pageSize": "10",
  "sortBy": {
    "field": "firstName",
    "order": "asc"
  }
}

200Success

[
  {
    "id": 1,
    "organizationId": 123,
    "externalId": "ext-12345",
    "consumerUuid": "550e8400-e29b-41d4-a716-446655440000",
    "authenticationId": "auth-12345",
    "firstName": "John",
    "lastName": "Doe",
    "timeZone": "GMT",
    "birthDate": "1990-01-01",
    "createdAt": "2023-01-01",
    "gender": "Male",
    "email": "[email protected]",
    "mobileNumber": "+1234567890",
    "guardianId": 2,
    "guardian": [],
    "addressLine1": "123 Main St",
    "addressLine2": "Apt 4B",
    "city": "New York",
    "state": "NY",
    "zipCode": "10001",
    "currency": "USD",
    "country": "USA",
    "isPrimary": true,
    "isPatient": true,
    "relationship": [],
    "relationshipType": "SELF",
    "dependants": [],
    "idProof": {},
    "insuranceDetails": {},
    "attributes": {},
    "addresses": [],
    "externalConsumer": [],
    "lastLoginAt": "2023-01-01",
    "active": true,
    "profilePicFileId": 3,
    "profilePictureCloudId": "cloud-12345",
    "profilePicture": "http://example.com/profile.jpg",
    "isWelcomeEmailSent": true,
    "forwardRelationship": [],
    "referrals": {},
    "recordSource": "INTERNAL",
    "populationTagIds": [],
    "populationTags": [],
    "tagsToAdd": [],
    "tagsToRemove": [],
    "wallets": {},
    "careTeams": [],
    "relatedConsumerId": 2
  }
]

PreviousConsumer lookup NextConversations