• Resource Categories
  • getLists resource categories.
  • postCreate resource category.
  • getGet resource category.
  • putUpdate resource category.

API docs by Redocly

Absorb Integration API (v2)

Download OpenAPI specification:Download

Resource Categories

Lists resource categories.

Authorizations:

api_key

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

Array

id	string <guid> The unique resource category identifier.
name	string The resource category's name.
parentId	string <guid> The resource category's parent ID.
description	string The resource category's description.

US

https://rest.myabsorb.com/resource-categories

CA

https://rest.myabsorb.ca/resource-categories

EU

https://rest.myabsorb.eu/resource-categories

AU

https://rest.myabsorb.com.au/resource-categories

Response samples

• 200

Content type

application/json

[

• {

  • "id": "string",
  • "name": "string",
  • "parentId": "string",
  • "description": "string"

  }

]

Create resource category.

Authorizations:

api_key

header Parameters

x-api-key	string
x-api-version	string 2

Request Body schema: application/json

id	string <guid> The unique identifier to use for the resource category. If not supplied one will be created.
name required	string [ 0 .. 4000 ] characters The name.
parentId	string <guid> The ID of the parent resource category (if any).
description	string The description.

Responses

Response Schema: application/json

id	string <guid> The unique resource category identifier.
name	string The resource category's name.
parentId	string <guid> The resource category's parent ID.
description	string The resource category's description.

US

https://rest.myabsorb.com/resource-categories

CA

https://rest.myabsorb.ca/resource-categories

EU

https://rest.myabsorb.eu/resource-categories

AU

https://rest.myabsorb.com.au/resource-categories

Request samples

• Payload

Content type

application/json

{

• "id": "string",
• "name": "string",
• "parentId": "string",
• "description": "string"

}

Response samples

• 201
• 403
• 422

Content type

application/json

{

• "id": "string",
• "name": "string",
• "parentId": "string",
• "description": "string"

}

Get resource category.

Authorizations:

api_key

path Parameters

id required

string <guid> The ID of the resource category.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

id	string <guid> The unique resource category identifier.
name	string The resource category's name.
parentId	string <guid> The resource category's parent ID.
description	string The resource category's description.

US

https://rest.myabsorb.com/resource-categories/{id}

CA

https://rest.myabsorb.ca/resource-categories/{id}

EU

https://rest.myabsorb.eu/resource-categories/{id}

AU

https://rest.myabsorb.com.au/resource-categories/{id}

Response samples

• 200
• 404

Content type

application/json

{

• "id": "string",
• "name": "string",
• "parentId": "string",
• "description": "string"

}

Update resource category.

Authorizations:

api_key

path Parameters

id required

string <guid> The ID of the resource category.

header Parameters

x-api-key	string
x-api-version	string 2

Request Body schema: application/json

The model for the resource category data.

name	string The resource category name.
parentId	string <guid> The resource category parent ID.
description	string The resource category description.

Responses

Response Schema: application/json

id	string <guid> The unique resource category identifier.
name	string The resource category's name.
parentId	string <guid> The resource category's parent ID.
description	string The resource category's description.

US

https://rest.myabsorb.com/resource-categories/{id}

CA

https://rest.myabsorb.ca/resource-categories/{id}

EU

https://rest.myabsorb.eu/resource-categories/{id}

AU

https://rest.myabsorb.com.au/resource-categories/{id}

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "parentId": "string",
• "description": "string"

}

Response samples

• 201
• 404
• 422

Content type

application/json

{

• "id": "string",
• "name": "string",
• "parentId": "string",
• "description": "string"

}