---
title: "Query lookups"
method: GET
path: "/lookups"
tags: ["Lookup"]
---

# Query lookups

`GET /lookups`

## Request

- Base URL: `https://r38.coupadev.com/api`
- URL: `https://r38.coupadev.com/api/lookups`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://r38.coupadev.com/oauth2/authorizations/new`
    - Token URL: `https://r38.coupadev.com/oauth2/token`
  - OAuth 2
    - Client credentials
    - Token URL: `https://r38.coupadev.com/oauth2/access_tokens`
- TypeScript: <https://skmtc.dev/coupa/apis/coupa-api-4/docs/lookups/get.ts> (a function with typed inputs; its response is checked against the schema)

Query lookups

## Query parameters

- `limit` integer
- `offset` integer
- `order_by` string
- `dir` 'asc' | 'desc'
- `return_object` 'limited' | 'shallow' | 'none'
- `filter` string

## Response `200`

Lookup objects

- Lookup[]
  - `active` boolean: A false value will inactivate the account making it no longer available to users. A true value will make it active and available to users.
  - `content-groups` BusinessGroup[]
    - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
    - `created-by` UserSimple
      - `avatar-thumb-url` string, string: Avatar url
      - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `email` string, string(255), required: email
      - `employee-number` string, string(255): employee number
      - `firstname` string, string(40), required: first name
      - `fullname` string, string(255): full name
      - `id` integer: Coupa unique identifier
      - `lastname` string, string(40), required: last name
      - `login` string, string(255), required: login
      - `salesforce-id` string, string(255), required: salesforce_id
      - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
    - `description` string, string(255): description
    - `id` integer: Coupa unique identifier
    - `name` string, string(100), required: name
    - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
    - `updated-by` UserSimple
      - `avatar-thumb-url` string, string: Avatar url
      - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `email` string, string(255), required: email
      - `employee-number` string, string(255): employee number
      - `firstname` string, string(40), required: first name
      - `fullname` string, string(255): full name
      - `id` integer: Coupa unique identifier
      - `lastname` string, string(40), required: last name
      - `login` string, string(255), required: login
      - `salesforce-id` string, string(255), required: salesforce_id
      - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
  - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
  - `created-by` UserSimple
    - `avatar-thumb-url` string, string: Avatar url
    - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
    - `email` string, string(255), required: email
    - `employee-number` string, string(255): employee number
    - `firstname` string, string(40), required: first name
    - `fullname` string, string(255): full name
    - `id` integer: Coupa unique identifier
    - `lastname` string, string(40), required: last name
    - `login` string, string(255), required: login
    - `salesforce-id` string, string(255), required: salesforce_id
    - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
  - `description` string, string(255): description
  - `fixed-depth` boolean: fixed_depth
  - `id` integer: Coupa unique identifier
  - `level-10-name` string, string(255): level_10_name
  - `level-1-name` string, string(255): level_1_name
  - `level-2-name` string, string(255): level_2_name
  - `level-3-name` string, string(255): level_3_name
  - `level-4-name` string, string(255): level_4_name
  - `level-5-name` string, string(255): level_5_name
  - `level-6-name` string, string(255): level_6_name
  - `level-7-name` string, string(255): level_7_name
  - `level-8-name` string, string(255): level_8_name
  - `level-9-name` string, string(255): level_9_name
  - `name` string, string(255), required: name
  - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
  - `updated-by` UserSimple
    - `avatar-thumb-url` string, string: Avatar url
    - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
    - `email` string, string(255), required: email
    - `employee-number` string, string(255): employee number
    - `firstname` string, string(40), required: first name
    - `fullname` string, string(255): full name
    - `id` integer: Coupa unique identifier
    - `lastname` string, string(40), required: last name
    - `login` string, string(255), required: login
    - `salesforce-id` string, string(255), required: salesforce_id
    - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
  - `values-count` integer: Total count of lookup values for this lookup

## Other responses

- `400`: Bad Request
- `404`: Not Found

---

[API](https://skmtc.dev/coupa/apis/coupa-api-4.md) - [All operations](https://skmtc.dev/coupa/apis/coupa-api-4/llms.txt) - [OpenAPI document](https://skmtc.dev/coupa/apis/coupa-api-4/revisions/adc09cabd758?raw)