Categories

Operations for categories

Find All

GET /v1/networks/categories

This endpoint returns all categories on your account.

cURL
curl --request GET 'https://api.eflow.team/v1/networks/categories' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'
Response
{
  "categories": [
    {
      "network_category_id": 1,
      "network_id": 1,
      "name": "Finance",
      "status": "active",
      "time_created": 1489692867,
      "time_saved": 1489692867
    }
  ]
}

Find By ID

GET /v1/networks/categories/:categoryId

This is the endpoint that will return a singular categories.

Path Parameters

Parameter Description
categoryId The ID of the category you want to find

cURL
curl --request GET 'https://api.eflow.team/v1/networks/categories/1' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'
Response
{
  "network_category_id": 1,
  "network_id": 1,
  "name": "Finance",
  "status": "active",
  "time_created": 1489692867,
  "time_saved": 1489692867
}

Create

POST /v1/networks/categories

Body Params

name string

Name of the category.

status string

Status of the category. Can either be active or inactive.

Body Example
{
  "name": "Finance",
  "status": "active"
}

cURL
curl --request POST 'https://api.eflow.team/v1/networks/categories' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT BODY HERE>'
Response
{
  "network_category_id": 1,
  "network_id": 1,
  "name": "Finance",
  "status": "active",
  "time_created": 1489692867,
  "time_saved": 1489692867
}

Update

PUT /v1/networks/categories/:categoryId

You must specify all the fields, not only the ones you wish to update.

Path Parameters

Parameter Description
categoryId The ID of the category you want to update

Body Params

name string

Name of the category.

status string

Status of the category. Can either be active or inactive.

Body Example
{
  "name": "Finance",
  "status": "inactive"
}

cURL
curl --request PUT 'https://api.eflow.team/v1/networks/categories' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT BODY HERE>'
Response
{
  "network_category_id": 1,
  "network_id": 1,
  "name": "Finance",
  "status": "inactive",
  "time_created": 1489692867,
  "time_saved": 1717605352
}