Skip to content
SendTruss

List attribute definitions

GET
/attribute-definitions
curl --request GET \
  --url https://api.sendtruss.com/v1/attribute-definitions \
  --header 'Authorization: Bearer <token>'

By key, 50 to a page. One set of definitions serves every workspace.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Paginated set of AttributeDefinitionResource

Media typeapplication/json
object
data
required
Array<object>
AttributeDefinitionResource
object
key
required
string
name
required
string
type
required
string
required
required
boolean
created_at
required
string | null
links
required
object
first
required
string | null
last
required
string | null
prev
required
string | null
next
required
string | null
meta
required
object
path
required

Base path for paginator generated URLs.

string | null
per_page
required

Number of items shown per page.

integer
next_cursor
required

The “cursor” that points to the next set of items.

string | null
prev_cursor
required

The “cursor” that points to the previous set of items.

string | null
Examplegenerated
{
  "data": [
    {
      "key": "example",
      "name": "example",
      "type": "example",
      "required": true,
      "created_at": "example"
    }
  ],
  "links": {
    "first": "example",
    "last": "example",
    "prev": "example",
    "next": "example"
  },
  "meta": {
    "path": "example",
    "per_page": 1,
    "next_cursor": "example",
    "prev_cursor": "example"
  }
}

Headers

Section titled “Headers”
Request-Id
required
string format: uuid

This request’s id. Quote it when you ask us about the request.

401

Section titled “401”

The API key is missing, malformed, revoked or expired.

Media typeapplication/json
object
message
required

What went wrong, for a person to read. It may change, so branch on code.

string
code
required

What went wrong, for your code to branch on. A new code is not a breaking change.

string
Allowed values: unauthenticated
doc_url
required

The entry on our errors page that explains this code.

string format: uri
request_id
required

This request’s id, the same as its Request-Id header. Quote it when you ask us about the request.

string format: uuid
Example
{
  "code": "unauthenticated"
}

Headers

Section titled “Headers”
Request-Id
required
string format: uuid

This request’s id. Quote it when you ask us about the request.

429

Section titled “429”

Too many requests. Wait for the seconds in Retry-After.

Media typeapplication/json
object
message
required

What went wrong, for a person to read. It may change, so branch on code.

string
code
required

What went wrong, for your code to branch on. A new code is not a breaking change.

string
Allowed values: rate_limited
doc_url
required

The entry on our errors page that explains this code.

string format: uri
request_id
required

This request’s id, the same as its Request-Id header. Quote it when you ask us about the request.

string format: uuid
Example
{
  "code": "rate_limited"
}

Headers

Section titled “Headers”
Request-Id
required
string format: uuid

This request’s id. Quote it when you ask us about the request.

Retry-After
integer

Seconds to wait before trying again.