Search code generators

​

Search code generators

Query Parameters

  • page
    Type: string
    min length:  
    1

    page offset to display a range of records from

  • per_page
    Type: string
    min length:  
    1

    maximum number of records to return in the search

  • order
    Type: "asc" or "desc"enum

    sort the records in either ascending (asc) or descending (desc) order

  • sort_by
    Type: string

    comma-separated list of field names to sort records by

  • prefix
    Type: string

    filter by code prefix

  • description
    Type: string

    filter by description

  • status
    Type: "active" or "archived"enum

    filter by status

  • store_id
    Type: integer

    filter by store ID

  • created_at
    Type: stringFormat: date-time

    filter by creation timestamp (RFC3339)

Responses

  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/v1.0/codegen
curl 'https://api.sparkfly.com/v1.0/codegen?page=1&per_page=5000&order=asc&status=active' \
  --header 'X-Auth-Token: YOUR_SECRET_TOKEN'

{
  "page": 1,
  "per_page": 1,
  "total_entries": 1,
  "total_pages": 1,
  "code_generators": [
    {
      "code_generator": {
        "generation_type": "sparkfly",
        "buffer_type": "default",
        "code_length": 1,
        "description": "string",
        "prefix": "string",
        "store_id": 1,
        "status": "active",
        "id": 1,
        "account_id": 1,
        "created_at": "string",
        "updated_at": "string"
      },
      "errors": {}
    }
  ]
}

Code Generator Index response

Previous
Create code generator
Next
Get a code generator by code generator ID