Skip to content
TeamGrid Developer

List products

GET
/products
curl --request GET \
  --url 'https://api.de.teamgrid.app/v1/products?limit=50&archived=false' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
cursor
string
<= 1024 characters

Opaque cursor returned in meta.page.nextCursor.

limit
integer
default: 50 >= 1 <= 200
archived
boolean

Return archived resources instead of active resources.

disabled
boolean

Filter products by disabled status.

productGroupId
string
>= 1 characters <= 128 characters

Filter products by product group id.

Responses

Section titled “Responses”

200

Section titled “200”

A stable cursor page.

Media typeapplication/json
object
data
required
Array<object>

Product catalog entry. purchasePrice is finance-gated.

object
attributes
required
object
amount
required
number | null
<= 1000000000
annotation
required
string
<= 50000 characters
archived
required
boolean
costCenter
required
Array<string>
<= 2 items unique items
createdAt
required
string | null format: date-time
description
required
string
<= 50000 characters
disabled
required
boolean
financeAccount
required
string | null
<= 1000 characters
name
required
string
<= 500 characters
priceGroupIds
required
Array<string>
<= 100 items unique items
productGroupId
required
string | null
<= 128 characters
productNumber
required
string | null
<= 1000 characters
purchasePrice

Internal acquisition cost. Present only with products:finance:read.

number | null
<= 1000000000000
retailPrice
required
number | null
<= 1000000000000
taxRate
required
number | null
<= 100
unit
required
string | null
<= 1000 characters
updatedAt
required
string | null format: date-time
id
required
string
>= 1 characters <= 128 characters
type
required
string
Allowed value: product
meta
required
object
page
required
object
limit
required
integer
>= 1 <= 200
nextCursor
required
string | null
requestId
required
string
Example
{
  "data": [
    {
      "type": "product"
    }
  ]
}

400

Section titled “400”

The request is invalid.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

401

Section titled “401”

The bearer credential is missing, invalid, expired, or revoked.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

403

Section titled “403”

The credential has insufficient scope.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

429

Section titled “429”

The credential or source exceeded its rate limit.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

Headers

Section titled “Headers”
Retry-After
integer
>= 1

Minimum delay in seconds before retrying.

X-RateLimit-Limit
integer

Maximum requests in the current window.

X-RateLimit-Remaining
integer

Requests remaining in the current window.

X-RateLimit-Reset
integer

Unix time in milliseconds when the current window resets.

X-Request-Id
string

Request correlation identifier.

503

Section titled “503”

A required cell-local dependency is unavailable.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}