List Location Resources - Reach Marketing & Automation Documentation

List Location Resources

curl --request GET \
  --url https://api.embedreach.com/api/resources/locations

{
  "success": true,
  "message": "<string>",
  "data": {
    "results": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "schema_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "schemaDefinitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "platform_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "platformId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "businessId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "resource_external_id": "<string>",
        "resourceExternalId": "<string>",
        "created_at": "<string>",
        "createdAt": "<string>",
        "updated_at": "<string>",
        "updatedAt": "<string>",
        "data": {
          "locationId": "<string>",
          "name": "<string>",
          "address": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zipCode": "<string>",
          "address2": "<string>",
          "address3": "<string>"
        }
      }
    ],
    "pagination": {
      "hasNextPage": true,
      "total": 123,
      "cursor": "<string>"
    },
    "included": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "schema_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "schemaDefinitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "platform_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "platformId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "businessId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "resource_external_id": "<string>",
        "resourceExternalId": "<string>",
        "created_at": "<string>",
        "createdAt": "<string>",
        "updated_at": "<string>",
        "updatedAt": "<string>",
        "data": {
          "locationId": "<string>",
          "name": "<string>",
          "address": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zipCode": "<string>",
          "address2": "<string>",
          "address3": "<string>"
        }
      }
    ]
  }
}

GET

api

resources

locations

List Location Resources

curl --request GET \
  --url https://api.embedreach.com/api/resources/locations

{
  "success": true,
  "message": "<string>",
  "data": {
    "results": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "schema_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "schemaDefinitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "platform_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "platformId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "businessId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "resource_external_id": "<string>",
        "resourceExternalId": "<string>",
        "created_at": "<string>",
        "createdAt": "<string>",
        "updated_at": "<string>",
        "updatedAt": "<string>",
        "data": {
          "locationId": "<string>",
          "name": "<string>",
          "address": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zipCode": "<string>",
          "address2": "<string>",
          "address3": "<string>"
        }
      }
    ],
    "pagination": {
      "hasNextPage": true,
      "total": 123,
      "cursor": "<string>"
    },
    "included": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "schema_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "schemaDefinitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "platform_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "platformId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "businessId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "resource_external_id": "<string>",
        "resourceExternalId": "<string>",
        "created_at": "<string>",
        "createdAt": "<string>",
        "updated_at": "<string>",
        "updatedAt": "<string>",
        "data": {
          "locationId": "<string>",
          "name": "<string>",
          "address": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zipCode": "<string>",
          "address2": "<string>",
          "address3": "<string>"
        }
      }
    ]
  }
}

Headers

reach-tenant-id

string

If using a platform scoped JWT, you can pass in a header to impersonate a specific tenant to impersonate the request as.

Query Parameters

include

string

Comma-separated list of reference ($ref) fields to include in the response. (Supports nested references with dot notation)

filters

object

Map of field names to values to filter the resources by. Can be in the format ?filters[field_name]=value&filters[other_field_name]=value2

Show child attributes

filters.{key}

unknown

cursor

string

Cursor for pagination. Use the cursor from the previous response to get the next page.

limit

number | null

default:100

Number of items to return per page. Default is 100, maximum is 1000.

Response

Status 200 response

success

boolean

required

message

string

data

object

Show child attributes

data.results

object[]

required

Show child attributes

data.results.id

string<uuid>

required

Unique identifier for the resource

data.results.schema_definition_id

string<uuid>

required

[Deprecated] Please use schemaDefinitionId instead. ID of the schema definition for this resource

data.results.schemaDefinitionId

string<uuid>

required

ID of the schema definition for this resource

data.results.platform_id

string<uuid>

required

[Deprecated] Please use platformId instead. ID of the platform this resource belongs to

data.results.platformId

string<uuid>

required

ID of the platform this resource belongs to

data.results.business_id

string<uuid>

required

[Deprecated] Please use businessId instead. ID of the business this resource belongs to

data.results.businessId

string<uuid>

required

ID of the business this resource belongs to

data.results.resource_external_id

string

required

External ID of the resource

data.results.resourceExternalId

string

required

[Deprecated] Please use resourceExternalId instead. External ID of the resource

data.results.created_at

string

required

[Deprecated] Please use createdAt instead

data.results.createdAt

string

required

Creation timestamp

data.results.updated_at

string

required

[Deprecated] Please use updatedAt instead

data.results.updatedAt

string

required

Last update timestamp

data.results.data

object

required

Show child attributes

data.results.data.locationId

string

required

data.results.data.name

string

required

data.results.data.address

string

required

Primary address line

data.results.data.city

string

required

data.results.data.state

string

required

data.results.data.zipCode

string

required

data.results.data.address2

string

Secondary address line (apartment, suite, etc.)

data.results.data.address3

string

Additional address line

data.pagination

object

required

Show child attributes

data.pagination.hasNextPage

boolean

required

data.pagination.total

number

required

data.pagination.cursor

string | null

data.included

object[]

Included resources when specified in the include parameter

Show child attributes

data.included.id

string<uuid>

required

Unique identifier for the resource

data.included.schema_definition_id

string<uuid>

required

[Deprecated] Please use schemaDefinitionId instead. ID of the schema definition for this resource

data.included.schemaDefinitionId

string<uuid>

required

ID of the schema definition for this resource

data.included.platform_id

string<uuid>

required

[Deprecated] Please use platformId instead. ID of the platform this resource belongs to

data.included.platformId

string<uuid>

required

ID of the platform this resource belongs to

data.included.business_id

string<uuid>

required

[Deprecated] Please use businessId instead. ID of the business this resource belongs to

data.included.businessId

string<uuid>

required

ID of the business this resource belongs to

data.included.resource_external_id

string

required

External ID of the resource

data.included.resourceExternalId

string

required

[Deprecated] Please use resourceExternalId instead. External ID of the resource

data.included.created_at

string

required

[Deprecated] Please use createdAt instead

data.included.createdAt

string

required

Creation timestamp

data.included.updated_at

string

required

[Deprecated] Please use updatedAt instead

data.included.updatedAt

string

required

Last update timestamp

data.included.data

object

required

Show child attributes

data.included.data.locationId

string

required

data.included.data.name

string

required

data.included.data.address

string

required

Primary address line

data.included.data.city

string

required

data.included.data.state

string

required

data.included.data.zipCode

string

required

data.included.data.address2

string

Secondary address line (apartment, suite, etc.)

data.included.data.address3

string

Additional address line

Get Customer Resource Get Location Resource

⌘I

API Documentation

Headers

Query Parameters

Response