Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Security | Authorization

List the authorization requests that you have submitted or for which you are responsible

get

Authorization requests are requests by a user or customer for certain permission grant. Please check type definitions for current supported cases.

Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Query parameters
requestingCompaniesinteger · int32[]Optional

Filter by one or more requesting company ids.

typesstring[]Optional

Filter by one or multiple specific types

statusstring[]Optional

Filter by one or multiple specific statuses

createdAfterstring · date-timeOptional

Filter the requests created after the specified date.

sortBystring · enumOptional

Sort the requests by a given criterion

Possible values:
sortOrderstring · enumOptional

Order in which the result of a list request is sorted.

Possible values:
offsetinteger · int32Optional

Specifies the index of the first item to return

Default: 0
limitinteger · int32Optional

Specifies the maximum number of items to return (min: 1; max: 1000)

Default: 100
Responses
200

OK: A list of authorization requests.

application/json
totalinteger · int32Required
get/v1/security/authorization-requests
GET /v1/security/authorization-requests HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "previous": {
    "href": "text",
    "method": "text"
  },
  "next": {
    "href": "text",
    "method": "text"
  },
  "items": [
    {
      "requestingCompany": {
        "id": 83,
        "name": "equipme GmbH",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "approvingCompany": {
        "id": 83,
        "name": "equipme GmbH",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "creator": {
        "id": 1,
        "firstName": "Pierce",
        "lastName": "Bell",
        "fullName": "text",
        "email": "p.bell@foo.io",
        "username": "j.doe@foo.inc",
        "costCenter": "4645-2343",
        "costCenterId": 1,
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "processor": {
        "id": 1,
        "firstName": "Pierce",
        "lastName": "Bell",
        "fullName": "text",
        "email": "p.bell@foo.io",
        "username": "j.doe@foo.inc",
        "costCenter": "4645-2343",
        "costCenterId": 1,
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "type": "orderAuthorization",
      "status": "new",
      "created": "2026-01-01T00:00:00.000Z",
      "completed": "2026-01-01T00:00:00.000Z",
      "note": "text",
      "id": 916,
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "total": 1,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Create an authorization request

post

Authorization requests are requests by a user or customer for certain permission grant. Please check type definitions for current supported cases.

Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Body
typestring · enumRequiredPossible values:
notestring · max: 10000 · nullableOptional

A note on the authorization request. Supports html formatted text including inline css styles.

Example: This is a <b>required permission</b>.
Responses
201

Created: The created authorization request.

application/json
typestring · enumOptionalPossible values:
statusstring · enumOptionalPossible values:
createdstring · date-timeOptional

The date and time the authorization request was created.

completedstring · date-time · nullableOptional

The date and time the authorization request was completed.

notestring · nullableOptional

A note on the authorization request. Supports html formatted text including inline css styles.

idinteger · int64Required

The identifier of the authorization request.

Example: 916
post/v1/security/authorization-requests
POST /v1/security/authorization-requests HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "type": "orderAuthorization",
  "note": "This is a <b>required permission</b>."
}
{
  "requestingCompany": {
    "id": 83,
    "name": "equipme GmbH",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "approvingCompany": {
    "id": 83,
    "name": "equipme GmbH",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "creator": {
    "id": 1,
    "firstName": "Pierce",
    "lastName": "Bell",
    "fullName": "text",
    "email": "p.bell@foo.io",
    "username": "j.doe@foo.inc",
    "costCenter": "4645-2343",
    "costCenterId": 1,
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "processor": {
    "id": 1,
    "firstName": "Pierce",
    "lastName": "Bell",
    "fullName": "text",
    "email": "p.bell@foo.io",
    "username": "j.doe@foo.inc",
    "costCenter": "4645-2343",
    "costCenterId": 1,
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "type": "orderAuthorization",
  "status": "new",
  "created": "2026-01-01T00:00:00.000Z",
  "completed": "2026-01-01T00:00:00.000Z",
  "note": "text",
  "id": 916,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Retrieve a single authorization request by its id

get

Authorization requests are requests by a user or customer for certain permission grant. Please check type definitions for current supported cases.

Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters
requestIdinteger · int32Required

The identifier of the authorization request.

Responses
200

OK: The requested authorization request.

application/json
typestring · enumOptionalPossible values:
statusstring · enumOptionalPossible values:
createdstring · date-timeOptional

The date and time the authorization request was created.

completedstring · date-time · nullableOptional

The date and time the authorization request was completed.

notestring · nullableOptional

A note on the authorization request. Supports html formatted text including inline css styles.

idinteger · int64Required

The identifier of the authorization request.

Example: 916
get/v1/security/authorization-requests/{requestId}
GET /v1/security/authorization-requests/{requestId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "requestingCompany": {
    "id": 83,
    "name": "equipme GmbH",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "approvingCompany": {
    "id": 83,
    "name": "equipme GmbH",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "creator": {
    "id": 1,
    "firstName": "Pierce",
    "lastName": "Bell",
    "fullName": "text",
    "email": "p.bell@foo.io",
    "username": "j.doe@foo.inc",
    "costCenter": "4645-2343",
    "costCenterId": 1,
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "processor": {
    "id": 1,
    "firstName": "Pierce",
    "lastName": "Bell",
    "fullName": "text",
    "email": "p.bell@foo.io",
    "username": "j.doe@foo.inc",
    "costCenter": "4645-2343",
    "costCenterId": 1,
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "type": "orderAuthorization",
  "status": "new",
  "created": "2026-01-01T00:00:00.000Z",
  "completed": "2026-01-01T00:00:00.000Z",
  "note": "text",
  "id": 916,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Update an existing authorization request

patch

Authorization requests are requests by a user or customer for certain permission grant. Please check type definitions for current supported cases.

Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters
requestIdinteger · int32Required

The identifier of the authorization request.

Bodyobject · Operation[]
valueany · nullableOptional
pathstring · nullableOptional
opstring · nullableOptional
fromstring · nullableOptional
Responses
204

NoContent: Request has succeeded.

No content
patch/v1/security/authorization-requests/{requestId}
PATCH /v1/security/authorization-requests/{requestId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 245

[
  {
    "op": "add",
    "path": "/status",
    "value": "approved"
  },
  {
    "op": "add",
    "path": "/note",
    "value": "This is a <b>required permission</b>."
  },
  {
    "op": "add",
    "path": "/processorId",
    "value": 123
  },
  {
    "op": "add",
    "path": "/completed",
    "value": "2026-10-09T16:38:45.8527113Z"
  }
]
No content

Last updated

Was this helpful?