Repzo API - Category (1.0.0)

Download OpenAPI specification:Download

OpenAPI specification for Repzo Category endpoints.

Find categories

query Parameters

params

object

Query parameters for filtering categories

Responses

Response samples

200

Content type

application/json

{"data": [{"_id": "string",
"type": "main",
"name": "string",
"photo": "string",
"local_name": "string",
"icon": "string",
"disabled": true,
"position": 0,
"integration_meta": { },
"company_namespace": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
],
"total_result": 0,
"current_count": 0,
"total_pages": 0,
"current_page": 0,
"per_page": 0,
"first_page_url": "string",
"last_page_url": "string",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string"
}

Create a category

Request Body schema: application/json

name required	string Name of the category
company_namespace	Array of strings Company namespaces
type	string Value: "main" Category type
disabled	boolean Whether the category is disabled
photo	string Photo URL of the category
local_name	string Localized name of the category
icon	string Icon for the category
position	number Position of the category
	object Integration metadata

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"company_namespace": ["string"
],
"type": "main",
"disabled": true,
"photo": "string",
"local_name": "string",
"icon": "string",
"position": 0,
"integration_meta": { }
}

Response samples

201

Content type

application/json

{"_id": "string",
"type": "main",
"name": "string",
"photo": "string",
"local_name": "string",
"icon": "string",
"disabled": true,
"position": 0,
"integration_meta": { },
"company_namespace": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Get a category by ID

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"_id": "string",
"type": "main",
"name": "string",
"photo": "string",
"local_name": "string",
"icon": "string",
"disabled": true,
"position": 0,
"integration_meta": { },
"company_namespace": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Update a category

path Parameters

id

required

string

Request Body schema: application/json

name	string Name of the category
company_namespace	Array of strings Company namespaces
type	string Value: "main" Category type
disabled	boolean Whether the category is disabled
photo	string Photo URL of the category
local_name	string Localized name of the category
icon	string Icon for the category
position	number Position of the category
	object Integration metadata
_id	string Unique identifier for the category
createdAt	string <date-time> Creation timestamp
updatedAt	string <date-time> Last update timestamp
__v	number Version number

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"company_namespace": ["string"
],
"type": "main",
"disabled": true,
"photo": "string",
"local_name": "string",
"icon": "string",
"position": 0,
"integration_meta": { },
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"_id": "string",
"type": "main",
"name": "string",
"photo": "string",
"local_name": "string",
"icon": "string",
"disabled": true,
"position": 0,
"integration_meta": { },
"company_namespace": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Remove a category

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"_id": "string",
"type": "main",
"name": "string",
"photo": "string",
"local_name": "string",
"icon": "string",
"disabled": true,
"position": 0,
"integration_meta": { },
"company_namespace": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}