Lookup

Access system reference data and configuration values. Lookups provide standardized lists of values used throughout the system such as company types, job statuses, and service types.

Quick Reference

Method

Endpoint

Description

GET

/api/lookup/{masterConstantKey}

Get lookup values

GET

/api/lookup/{masterConstantKey}/{valueId}

GET

/api/lookup/countries

GET

/api/lookup/resetMasterConstantCache

GET

/api/lookup/accessKeys

GET

/api/lookup/accessKey/{accessKey}

GET

/api/lookup/documentTypes

GET

/api/lookup/items

GET

/api/lookup/referCategory

GET

/api/lookup/referCategoryHeirachy

GET

/api/lookup/PPCCampaigns

GET

/api/lookup/parcelPackageTypes

GET

/api/lookup/comonInsurance

GET

/api/lookup/contactTypes

GET /api/lookup/{masterConstantKey}

Get lookup values

Retrieves all values for a specific lookup type (e.g., CompanyTypes, ContactTypes, JobStatusTypes).

Parameters:

Path Parameters:

  • masterConstantKey (string, path) (required): No description available

Response Type:

Array of LookupValue objects

See the model documentation for detailed field descriptions.

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/lookup/{masterConstantKey}"
,
    masterConstantKey="example-value"

)

# Process the response
print(response)

Sample Response:

 1[
 2  {
 3    "id": "e7f85166-34cf-429b-805d-261b44cb0c04",
 4    "value": "Customer"
 5  },
 6  {
 7    "id": "f8a96277-45df-540c-916e-362b55da1d15",
 8    "value": "Vendor"
 9  },
10  {
11    "id": "a9b07388-56ef-651d-a27f-473c66eb2e26",
12    "value": "Carrier"
13  }
14]

GET /api/lookup/{masterConstantKey}/{valueId}

Parameters:

Path Parameters:

  • masterConstantKey (string, path) (required): No description available

  • valueId (string, path) (required): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/lookup/{masterConstantKey}/{valueId}"
,
    masterConstantKey="example-value"
,
    valueId="789e0123-e89b-12d3-a456-426614174002"

)

# Process the response
print(response)

Sample Response:

1{
2  "status": "success",
3  "data": {}
4}

GET /api/lookup/countries

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/lookup/countries"

)

# Process the response
print(response)

Sample Response:

1[]

GET /api/lookup/resetMasterConstantCache

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/lookup/resetMasterConstantCache"

)

# Process the response
print(response)

Sample Response:

1{
2  "status": "success",
3  "data": {}
4}

GET /api/lookup/accessKeys

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/lookup/accessKeys"

)

# Process the response
print(response)

Sample Response:

1[]

GET /api/lookup/accessKey/{accessKey}

Parameters:

Path Parameters:

  • accessKey (string, path) (required): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/lookup/accessKey/{accessKey}"
,
    accessKey="example-value"

)

# Process the response
print(response)

Sample Response:

1{
2  "status": "success",
3  "data": {}
4}

GET /api/lookup/documentTypes

Parameters:

Query Parameters:

  • documentSource (string, query): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/lookup/documentTypes"

)

# Process the response
print(response)

Sample Response:

1[]

GET /api/lookup/items

Parameters:

Query Parameters:

  • jobDisplayId (string, query): No description available

  • jobItemId (string, query): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/lookup/items"

)

# Process the response
print(response)

Sample Response:

1[]

GET /api/lookup/referCategory

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/lookup/referCategory"

)

# Process the response
print(response)

Sample Response:

1{
2  "status": "success",
3  "data": {}
4}

GET /api/lookup/referCategoryHeirachy

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/lookup/referCategoryHeirachy"

)

# Process the response
print(response)

Sample Response:

1{
2  "status": "success",
3  "data": {}
4}

GET /api/lookup/PPCCampaigns

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/lookup/PPCCampaigns"

)

# Process the response
print(response)

Sample Response:

1[]

GET /api/lookup/parcelPackageTypes

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/lookup/parcelPackageTypes"

)

# Process the response
print(response)

Sample Response:

1[]

GET /api/lookup/comonInsurance

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/lookup/comonInsurance"

)

# Process the response
print(response)

Sample Response:

1{
2  "status": "success",
3  "data": {}
4}

GET /api/lookup/contactTypes

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/lookup/contactTypes"

)

# Process the response
print(response)

Sample Response:

1[]