Useme API docs
  1. Categories
Useme API docs
  • Guides
    • Introduction
    • Getting Started
    • Creating Contractors
    • Creating Deals
  • Reference
    • Categories
      • List categories
        GET
    • Contractors
      • Create a new contractor
    • Deals
      • Create a new deal
      • Retrieve a specific deal
      • Upload a file for a deal
  1. Categories

List categories

GET
https://sandbox.useme.com/api/1.0/categories/
Categories
Retrieves a list of either main categories or subcategories. If an 'id' query parameter is not provided, it returns all main categories. If an 'id' query parameter is provided, it returns all subcategories related to the main category of the given 'id'.

Request

Query Params
id
integer 
optional
ID of a main category - to retrieve its subcategories.
Header Params
Authorization
string 
required
Authorization token for the sandbox environment.
Default:
Token <here-paste-your-token>

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://sandbox.useme.com/api/1.0/categories/' \
--header 'Authorization;'

Responses

🟢200A list of categories. The type of categories returned (main or sub) depends on the 'id' query parameter presence.
application/json
Body
array of:
pk
integer 
ID
read-onlyrequired
name
string 
required
<= 30 characters
Example
[
  {
    "pk": 0,
    "name": "string"
  }
]
Modified at 2024-05-07 08:34:28
Previous
Creating Deals
Next
Create a new contractor
Built with