Skip to main content
GET
/
api
/
v1
/
access_states
List access states
curl --request GET \
  --url https://api.accessowl.com/api/v1/access_states \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "application_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "effective_start": "2023-11-07T05:31:56Z",
      "grantee_user_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "application": {
        "description": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "owner_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "provisioning_type": "<string>",
        "risk_level": "<string>",
        "status": "<string>",
        "title": "<string>",
        "url": "<string>"
      },
      "effective_end": "2023-11-07T05:31:56Z",
      "grantee_user": {
        "deactivated_at": null,
        "departments": [
          "Engineering"
        ],
        "email": "john@example.com",
        "employment_type": "full_time",
        "first_name": "John",
        "full_name": "John Doe",
        "id": "7488a646-e31f-11e4-aace-600308960662",
        "inserted_at": "2023-01-01T00:00:00Z",
        "job_title": "Software Engineer",
        "last_name": "Doe",
        "location_city": "San Francisco",
        "manager_user_id": null,
        "status": "active",
        "teams": [
          "Engineering",
          "Backend"
        ],
        "updated_at": "2023-01-01T00:00:00Z"
      },
      "grantee_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "resource": {
        "application_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "description": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "multiple_permissions_selectable": true,
        "parent_resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "requestable": true,
        "title": "<string>",
        "type": "<string>"
      },
      "resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "target_permission_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "target_permissions": [
        {
          "description": "<string>",
          "elevated": true,
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "requestable": true,
          "resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "title": "<string>"
        }
      ]
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 20,
    "total_count": 100,
    "total_pages": 5
  }
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication. Pass your AccessOwl API token in the Authorization header as Bearer <token>.

Query Parameters

​
limit
integer

Maximum results to return (default: 20, max: 100)

​
cursor
string

Opaque cursor returned in the previous response's meta.next_cursor. Omit for the first page.

​
application_id
string

Filter by application ID

​
grantee_user_id
string

Filter by grantee user ID

​
expand
string

Comma-separated list of related objects to embed inline alongside their ID fields. Allowed values: grantee_user, application, resource, target_permissions. Embedded objects carry their own top-level fields only (no further nesting). An unknown value returns 400.

Response

Access state list

Paginated list of access states

​
data
AccessState · object[]
required

List of access states

​
meta
PaginationMeta · object
required

Pagination metadata

Example:
{
  "page": 1,
  "page_size": 20,
  "total_count": 100,
  "total_pages": 5
}