---
title: "ApiAccesses.list"
method: GET
path: "/entities/ApiAccesses"
tags: ["Api"]
---

# ApiAccesses.list

`GET /entities/ApiAccesses`

Returns all defined ApiAccesses

## Query parameters

- `include-deleted` boolean
- `first` integer
- `last` integer
- `before` string
- `after` string
- `expand` string
- `order-by` string
- `filter` object
- `filter-op` object
- `load-only` string

## Response `200`

list of ApiAccesses

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` ApiAccess[]
    - `is_delete_protected` boolean, required — Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.
    - `id` string, uuid, required — Unique identifier of entity. Must match with Application id.
    - `is_deleted` boolean — Specifies if the entity is considered deleted.
    - `modified` string, date-time — Last modification time.
    - `created` string, date-time — Creation time.
    - `email` string — Contact email associated with this API access. Used for credential change notifications.
    - `is_active` boolean — Whether this API access can authenticate. Set to false to disable the credentials without deleting the record; existing tokens stop working immediately.
    - `last_used` string, date-time — Timestamp of the most recent successful authentication using this API access. Updated automatically on each use; empty for credentials that have never been used.
    - `permissions` object — Per-section access permissions (records, administration, misc) granted to this API access. Determines which entities and operations the credentials can read or write.
    - `type` 1 | 2, required — Authentication type of this API access (e.g. standard API key vs. OAuth client). Set automatically on create and cannot be changed. Integer enum value: 1 - Basic, 2 - OAuth
    - `name` string, required — Name for the api access.
    - `username` string — Username portion of the API credentials issued for this access.
    - `plain_password` string — Plain-text password issued for this API access. Returned only at create time and for migrated legacy access; otherwise empty. Integrators must store it on receipt — it is not retrievable later.
  - `page_info` object — Page info result set. Please note it is returned only when legacy limit & offset parameters are not used.
    - `start_cursor` string — Start cursor of result set.
    - `end_cursor` string — End cursor of result set.
    - `has_previous_page` boolean — If result set has previous page (if yes, use start_cursor value in before parameter to load it).
    - `has_next_page` boolean — If result set has next page (if yes, use end_cursor value in after parameter to load it).

## Other responses

- `500` — unexpected error

---

[API](https://skmtc.net/aws/apis/pipeliner-cloud-api.md) · [All operations](https://skmtc.net/aws/apis/pipeliner-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/pipeliner-cloud-api/versions/e8c12ae60aca/schema)