MyIPR API
  • Welcome
  • GETTING STARTED
    • Generate API Key
  • API GUIDES
    • Overview
    • Authentication
    • Rate Limiting
    • Errors
    • Pagination
    • API Reference
      • Get all categories
      • Get all files
      • Create Certificate
      • Get file versions
      • Get version details
      • Get version certificate
Powered by GitBook
On this page
  1. API GUIDES
  2. API Reference

Get all categories

Use this API to list all active categories available on the MyIPR App to create a certificate.

End Point

{{base_url}}/categories

API Description

This API serves the purpose of retrieving a comprehensive list of all currently active categories within the MyIPR App, facilitating the seamless creation of certificates. It is imperative to note that a valid category ID is a prerequisite when generating a certificate. The response from this API furnishes a selection of suitable category IDs, allowing users to make informed choices during the certificate creation process.

Method

GET

Attributes

Attribute
Type
Description

status

Integer

Represents the status of the API response.

message

String

Provides a message indicating the success or failure of the API request.

result

Array

An array containing objects with information about different categories.

result.id

Integer

Unique identifier for a category.

result.name

String

The name of the category.

Request

// curl --location -g '{{base_url}}/categories' \
--header 'Authorization: SECRET {{secret_key}}'

Response

// {
  "status": 201,
  "message": "success",
  "result": [
    {
      "id": 5,
      "name": "Music"
    },
    {
      "id": 7,
      "name": "Art"
    },
    {
      "id": 8,
      "name": "Culture"
    },
    {
      "id": 9,
      "name": "Buissness"
    },
    {
      "id": 10,
      "name": "Legal"
    },
    {
      "id": 11,
      "name": "Album"
    }
  ]
} 
PreviousAPI ReferenceNextGet all files

Last updated 1 year ago