Groups

Get address groups

get

Get address groups based on the provided filter criteria

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Query parameters

namestringOptional

Name of the Address

Example: Name

typestring · enumOptional

Type of the address

Default: PRIMARYExample: LABPossible values:

regionstringOptional

Region of the address group

Example: New York

activebooleanRequired

Status of the address group

Default: trueExample: true

appointmentTypeIdnumberOptional

Appointment Type Id

Example: 1

includeAddressCountbooleanOptional

Flag to include address list count

Example: true

includeAddressMappingbooleanOptional

Flag to include address list

Example: true

Responses

200Success

application/json

get

/api/addresses/groups

HTTPcURLJavaScriptPython

GET /api/addresses/groups?active=true HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "id": 12,
    "name": "Name",
    "description": "Lab",
    "region": "New York",
    "type": "LAB",
    "organizationId": 1,
    "active": true,
    "addressGroupMapping": [],
    "createdAt": "2023-01-01T00:00:00.000Z",
    "updatedAt": "2023-01-01T00:00:00.000Z",
    "addressMappingCount": 1
  }
]

Create address group

post

Create address group based on the provided data

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Body

application/json

namestringRequired

Name of the Address

Example: Name

descriptionstringOptional

Description of the address group

Example: Lab

regionstringOptional

Region of the address group

Example: New York

typestring · enumRequired

Type of the address

Default: PRIMARYExample: LABPossible values:

activebooleanRequired

Status of the address group

Default: trueExample: true

Responses

200Success

application/json

post

/api/addresses/groups

HTTPcURLJavaScriptPython

POST /api/addresses/groups 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: 107

{
  "name": "Name",
  "description": "Lab",
  "region": "New York",
  "type": "LAB",
  "active": true,
  "addressGroupMapping": []
}

200Success

{
  "id": 12,
  "name": "Name",
  "description": "Lab",
  "region": "New York",
  "type": "LAB",
  "organizationId": 1,
  "active": true,
  "addressGroupMapping": [],
  "createdAt": "2023-01-01T00:00:00.000Z",
  "updatedAt": "2023-01-01T00:00:00.000Z",
  "addressMappingCount": 1
}

Get address group by ID

get

Retrieves an address group based on the provided ID

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

idnumberRequiredPattern: [^\/#\?]+?

Responses

200Success

application/json

get

/api/addresses/groups/{id}

HTTPcURLJavaScriptPython

GET /api/addresses/groups/{id} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

{
  "id": 12,
  "name": "Name",
  "description": "Lab",
  "region": "New York",
  "type": "LAB",
  "organizationId": 1,
  "active": true,
  "addressGroupMapping": [],
  "createdAt": "2023-01-01T00:00:00.000Z",
  "updatedAt": "2023-01-01T00:00:00.000Z",
  "addressMappingCount": 1
}

Update address group

put

Update address group based on the provided data

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

idnumberRequiredPattern: [^\/#\?]+?

Body

application/json

namestringRequired

Name of the Address

Example: Name

descriptionstringOptional

Description of the address group

Example: Lab

regionstringOptional

Region of the address group

Example: New York

typestring · enumRequired

Type of the address

Default: PRIMARYExample: LABPossible values:

activebooleanRequired

Status of the address group

Default: trueExample: true

Responses

200Success

application/json

put

/api/addresses/groups/{id}

HTTPcURLJavaScriptPython

PUT /api/addresses/groups/{id} 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: 107

{
  "name": "Name",
  "description": "Lab",
  "region": "New York",
  "type": "LAB",
  "active": true,
  "addressGroupMapping": []
}

200Success

{
  "id": 12,
  "name": "Name",
  "description": "Lab",
  "region": "New York",
  "type": "LAB",
  "organizationId": 1,
  "active": true,
  "addressGroupMapping": [],
  "createdAt": "2023-01-01T00:00:00.000Z",
  "updatedAt": "2023-01-01T00:00:00.000Z",
  "addressMappingCount": 1
}