---
title: "get all"
method: GET
path: "/interaction_categories"
tags: ["Interaction Categories"]
---

# get all

`GET /interaction_categories`

Returns all of the **interaction categories** in the organisation
#### For custom components:
`RaiselyComponents.api.all('interaction_categories').get(params = {}, headers = {}) => Promise<{result}>`

 :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper

## Query parameters

- `private` boolean
- `q` string
- `limit` number
- `offset` number
- `sort` string
- `order` 'asc' | 'desc'

## Headers

- `Authorization` string

## Response `200`

The resulting collection of Interaction Category records

- object
  - `data` MemberInteractionCategory[]
    - `createdAt` string — `public` Date the record was created
    - `description` string — `public`
    - `fields` NestedField[] — `public`
      - `active` boolean — `public` Only active fields may be included in forms
      - `config` object — `public` Additional configuration parameters for this field
      - `core` boolean — `public` Determines if this field represents a core record value (such as user.firstName or profile.name)
      - `createdAt` string — `public` Date the record was created
      - `default` string — `public` The initial value to set for the field in a new form (or a form for a record where the field has no value)
      - `description` string — `public` Additional help context for this field
      - `label` string, required — `public` The label used to display this field to a user or admin
      - `locked` boolean — `public` The editable status of this field
      - `name` string, required — `public` The identity of this field (the field will be stored as { [name]: value }).
      - `options` object — `public` Array of options for select fields
      - `placeholder` string — `public` The placeholder value to show when this field is empty or uninitialized
      - `private` boolean — `public` Private values for this record
      - `recordType` string, required — `public` The type of record this field is for
      - `sortOrder` integer — `public` The order to display the field on a form, relative to all other fields for the same record type
      - `type` string, required — `public` The format used for entering, displaying and storing this field
      - `updatedAt` string — `public` Date the record was last updated
      - `uuid` string — `public` Unique identifier for the record
      - `validation` string — `public`
      - `visible` boolean — `public` Indicates if this field is intended to be editable by a user, or hidden from view
    - `group` string — `public`
    - `isCore` boolean — `public`
    - `label` string — `public`
    - `path` string — `public` The path of this record (for alternative lookup)
    - `priority` integer — `public`
    - `updatedAt` string — `public` Date the record was last updated
    - `uuid` string — `public` Unique identifier for the record
  - `pagination` Pagination
    - `total` integer — The total amount of records returned
    - `pages` integer — The amount of pages (by limit) returned
    - `prevUrl` union — Url that points to the previous set of records in the pagination if available
      - string
      - boolean
    - `nextUrl` union — Url that points to the next set of records in the pagination if available
      - string
      - boolean
    - `offset` integer — The total number of records to offset in the pagination
    - `limit` integer — The maximum amount of records to shown in each page

## Other responses

- `401` — Authorization credentials were missing or invalid
- `403` — The user is authenticated, but is not allowed to perform the requested operation
- `410` — The requested record no longer exists, or that API has been deprecated
- `429` — You have made too many requests to the given endpoint, please try again later
- `500` — An unexpected error has occurred with Raisely. If the error persists you can contact support@raisely.com

---

[API](https://skmtc.dev/raisely/apis/raisely-api.md) · [All operations](https://skmtc.dev/raisely/apis/raisely-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/raisely/raisely-api/revisions/d7f8dd294cb0/schema)