Explore documentation
  1. Welcome to Incidents 👋
  2. Frequently Asked Questions
  3. On-call scheduling and alerting
    1. Get started
    2. Slack and other integrations ↗
    3. Tag on-call in Slack
    4. Mobile apps ↗
    5. Connecting external calendars
    6. Advanced guide
  4. Incident management
    1. Get started
    2. AI SRE investigations
    3. Post mortems
    4. Metadata & Catalog
    5. Screening alerts
    6. Reporting ↗
  5. Monitoring
    1. Get started
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  6. Status pages
    1. Get started
    2. Advanced guide
  7. Incidents API
    1. Getting an API token
    2. Pagination
    3. Monitors
    4. Heartbeats
    5. On-call & incidents
    6. Status pages
    7. Metadata
    8. Integrations
      1. New Relic
      2. Datadog
      3. AWS CloudWatch
      4. Amazon SNS
      5. Microsoft Azure
      6. Google Monitoring
      7. Grafana
      8. Elastic
      9. Prometheus
      10. E-mail
      11. Incoming webhooks
      12. Atlassian Jira
      13. Slack
      14. Outgoing webhooks
      15. Outgoing e‑mails
      16. Splunk On-Call
      17. PagerDuty
      18. Catalog
        1. Catalog relations
        2. Catalog attributes
          1. List catalog attributes GET
          2. Get catalog attribute GET
          3. Create catalog attribute POST
          4. Update catalog attribute PATCH
          5. Remove catalog attribute DELETE
        3. Catalog records
    9. Team members
    10. Organization roles
    11. Usage
    12. Reporting

List catalog attributes

Returns a list of all Catalog attributes for a Catalog relation.

GET https://incidents.betterstack.com/api/v2/catalog/relations/{relation_id}/attributes

URL parameters

relation_id
required string

The ID of the Catalog relation you want to get attributes for.

Headers

Authorization
required string

Bearer $TOKEN

200

Returns a list of existing Catalog attributes, sorted by position.

Response body

{
  "data": [
    {
      "id": "56",
      "type": "catalog_attribute",
      "attributes": {
        "name": "Team",
        "primary": true,
        "position": 0
      }
    },
    {
      "id": "57",
      "type": "catalog_attribute",
      "attributes": {
        "name": "Team Lead",
        "primary": false,
        "position": 1
      }
    }
  ]
}

Response attributes

id
string

The ID of the Catalog attribute.

type
string

Always catalog_attribute.

attributes.name
string

The name of the Catalog attribute.

attributes.primary
boolean

Whether this is a primary attribute. Primary attributes are matched against the incident metadata key of the same name.

attributes.position
integer

The position of the attribute in the Catalog relation, lower values first.

Example cURL

Example
curl --request GET \
  --url https://incidents.betterstack.com/api/v2/catalog/relations/37/attributes \
  --header "Authorization: Bearer $TOKEN"


Previous article

Remove catalog relation

Next article

Get catalog attribute