--- updatedAt: 2026-05-27T09:29:13.000Z agentTools: projectIndex: https://pennylane.readme.io/llms.txt --- # List categories of a category group List categories of a category group > ℹ️ > This endpoint requires one of the following scopes: `categories:all`, `categories:readonly` # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "Company V2", "description": "Automate your accounting with the Pennylane API. [Documentation](https://pennylane.readme.io/)", "contact": { "email": "tech@pennylane.com" }, "version": "2.0" }, "x-readme": { "samples-languages": [ "curl", "node", "ruby", "php", "python", "java" ] }, "servers": [ { "url": "https://app.pennylane.com" } ], "paths": { "/api/external/v2/category_groups/{category_group_id}/categories": { "get": { "operationId": "getCategoryGroupCategories", "summary": "List categories of a category group", "description": "List categories of a category group\n\n> ℹ️\n> This endpoint requires one of the following scopes: `categories:all`, `categories:readonly`", "tags": [ "Category Groups" ], "security": [ { "oauth2": [ "categories:all", "categories:readonly" ] } ], "parameters": [ { "name": "category_group_id", "description": "The unique identifier of the category group", "in": "path", "schema": { "type": "integer" }, "required": true, "example": 42 }, { "name": "cursor", "description": "Cursor for pagination. Use this to fetch the next set of results.\nThe cursor is an opaque string returned in the previous response's metadata.\nLeave empty for the first request.\n", "in": "query", "schema": { "type": "string", "example": "dXBkYXRlZF9hdDoxNjc0MTIzNDU2" }, "required": false }, { "name": "limit", "description": "Number of items to return per request.\nDefaults to 20 if not specified.\nMust be between 1 and 100.\n", "in": "query", "schema": { "type": "integer", "example": 20, "minimum": 1, "maximum": 100 }, "required": false }, { "name": "X-Company-Id", "description": "Numeric ID of the company to act on. Required when authenticating with a firm token. Ignored when the token is already bound to a company.", "in": "header", "schema": { "type": "string", "example": "12345" }, "required": false } ], "responses": { "200": { "description": "A list of categories of a category group", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "has_more": { "description": "Indicates whether additional results are available beyond this set.\nUse this flag to determine if another request is needed.\n", "type": "boolean", "example": true }, "next_cursor": { "description": "Cursor to retrieve the next set of results.\nInclude this value in the cursor parameter of your next request to fetch subsequent items.\nA `null` `next_cursor` in the response indicates no further results.\n", "type": "string", "nullable": true, "example": "dXBkYXRlZF9hdDoxNjc0MTIzNDU2" }, "items": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer", "format": "int64", "example": 42 }, "label": { "type": "string", "example": "Alimentaire" }, "direction": { "anyOf": [ { "type": "string", "description": "Only applicable for _treasury_ categories", "enum": [ "cash_in", "cash_out" ] }, { "nullable": true, "type": "string", "enum": [ null ] } ] }, "analytical_code": { "type": "string", "nullable": true, "example": "CODE123" }, "created_at": { "type": "string", "format": "date-time", "example": "2023-08-30T10:08:08.146343Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2023-08-30T10:08:08.146343Z" }, "ledger_account": { "description": "The ledger account the category is wired to, or `null` when none is set.", "type": "object", "nullable": true, "additionalProperties": false, "properties": { "id": { "type": "integer", "format": "int64", "example": 124 }, "url": { "description": "The URL to the ledger account", "type": "string", "example": "https://app.pennylane.com/api/external/v2/ledger_accounts/124" } }, "required": [ "id", "url" ] } }, "required": [ "id", "label", "direction", "analytical_code", "created_at", "updated_at", "ledger_account" ] } } }, "required": [ "has_more", "next_cursor", "items" ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "additionalProperties": false, "properties": { "error": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "error", "status" ] }, { "type": "object", "additionalProperties": false, "properties": { "message": { "type": "string" } }, "required": [ "message" ] }, { "type": "object", "additionalProperties": false, "properties": { "message": { "type": "string" }, "code": { "type": "string", "enum": [ "InvalidDateFormat", "InvalidDateTimeFormat", "InvalidEmailFormat", "InvalidPattern", "InvalidUUIDFormat", "LessThanExclusiveMinimum", "LessThanMinimum", "LessThanMinItems", "LessThanMinLength", "MoreThanExclusiveMaximum", "MoreThanMaximum", "MoreThanMaxItems", "MoreThanMaxLength", "NotAMultipartFile", "NotAnyOf", "NotEnumInclude", "NotExistContentTypeDefinition", "NotExistDiscriminatorMappedSchema", "NotExistDiscriminatorPropertyName", "NotExistPropertyDefinition", "NotExistRequiredKey", "NotExistStatusCodeDefinition", "NotNullError", "NotOneOf", "ValidateError" ] } }, "required": [ "message", "code" ] }, { "type": "object", "additionalProperties": false, "properties": { "message": { "type": "string" }, "field": { "type": "string" }, "code": { "type": "string", "enum": [ "InvalidDateFormat", "InvalidDateTimeFormat", "InvalidEmailFormat", "InvalidPattern", "InvalidUUIDFormat", "LessThanExclusiveMinimum", "LessThanMinimum", "LessThanMinItems", "LessThanMinLength", "MoreThanExclusiveMaximum", "MoreThanMaximum", "MoreThanMaxItems", "MoreThanMaxLength", "NotAMultipartFile", "NotAnyOf", "NotEnumInclude", "NotExistContentTypeDefinition", "NotExistDiscriminatorMappedSchema", "NotExistDiscriminatorPropertyName", "NotExistPropertyDefinition", "NotExistRequiredKey", "NotExistStatusCodeDefinition", "NotNullError", "NotOneOf", "ValidateError" ] } }, "required": [ "message", "field", "code" ] }, { "type": "object", "additionalProperties": false, "properties": { "message": { "type": "string" }, "payload": { "type": "string" }, "code": { "type": "string", "enum": [ "InvalidDateFormat", "InvalidDateTimeFormat", "InvalidEmailFormat", "InvalidPattern", "InvalidUUIDFormat", "LessThanExclusiveMinimum", "LessThanMinimum", "LessThanMinItems", "LessThanMinLength", "MoreThanExclusiveMaximum", "MoreThanMaximum", "MoreThanMaxItems", "MoreThanMaxLength", "NotAMultipartFile", "NotAnyOf", "NotEnumInclude", "NotExistContentTypeDefinition", "NotExistDiscriminatorMappedSchema", "NotExistDiscriminatorPropertyName", "NotExistPropertyDefinition", "NotExistRequiredKey", "NotExistStatusCodeDefinition", "NotNullError", "NotOneOf", "ValidateError" ] } }, "required": [ "message", "payload", "code" ] }, { "type": "object", "additionalProperties": false, "properties": { "message": { "type": "string" }, "field": { "type": "string" }, "payload": { "type": "string" }, "code": { "type": "string", "enum": [ "InvalidDateFormat", "InvalidDateTimeFormat", "InvalidEmailFormat", "InvalidPattern", "InvalidUUIDFormat", "LessThanExclusiveMinimum", "LessThanMinimum", "LessThanMinItems", "LessThanMinLength", "MoreThanExclusiveMaximum", "MoreThanMaximum", "MoreThanMaxItems", "MoreThanMaxLength", "NotAMultipartFile", "NotAnyOf", "NotEnumInclude", "NotExistContentTypeDefinition", "NotExistDiscriminatorMappedSchema", "NotExistDiscriminatorPropertyName", "NotExistPropertyDefinition", "NotExistRequiredKey", "NotExistStatusCodeDefinition", "NotNullError", "NotOneOf", "ValidateError" ] } }, "required": [ "message", "field", "payload", "code" ] } ] } } } }, "401": { "description": "Access token is missing or invalid", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "error": { "type": "string", "example": "The access token is invalid" }, "status": { "type": "integer", "example": 401 } }, "required": [ "error", "status" ] } } } }, "403": { "description": "Access to this resource forbidden", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "error": { "type": "string", "example": "Access to this resource requires scope \"ledger\"." }, "status": { "type": "integer", "example": 403 } }, "required": [ "error", "status" ] } } } }, "404": { "description": "The resource was not found", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "error": { "type": "string", "example": "Not Found" }, "status": { "type": "integer", "example": 404 } }, "required": [ "error", "status" ] } } } } } } } }, "components": { "securitySchemes": { "oauth2": { "type": "oauth2", "flows": { "authorizationCode": { "authorizationUrl": "https://app.pennylane.com/oauth/authorize", "tokenUrl": "https://app.pennylane.com/oauth/oauth/token", "refreshUrl": "https://app.pennylane.com/oauth/oauth/token", "scopes": { "ledger": "Grant create, update and read access to Ledger Entries and its related resources" } } } } } } } ```