find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/altoviz-com:altoviz-com-customerfamilies-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Altoviz Customer Families API
  description: 'RESTful APIs for the Altoviz services


    ## Deprecations


    ### Product prices


    A product now stores its sale price both excluding and including tax, so both are

    returned, along with the margin figures derived from them: `taxExcludedPrice`,

    `taxIncludedPrice`, `margin`, `markupRate` (margin over cost, FR « taux de marge ») and

    `marginRate` (margin over sale price, FR « taux de marque »).


    Two fields are deprecated as a result:


    | Deprecated | Use instead |

    | --- | --- |

    | `unitPrice` | `taxExcludedPrice` |

    | `isUnitPriceTaxIncluded` | `taxIncludedPrice`, to send a tax-included price |


    **`unitPrice` is now always the tax-excluded price.** It previously held whichever half

    the product was priced in, which `isUnitPriceTaxIncluded` told you. For a product priced

    tax-included, `unitPrice` therefore returns a different number than it used to, and

    `isUnitPriceTaxIncluded` is now always `false`. If you read the flag before using the

    price, your result is unchanged. If you assumed the price was tax-included, read

    `taxIncludedPrice`.


    Writing is unaffected. Both fields are still accepted and behave exactly as before:

    `unitPrice` alone is read as tax-excluded, and setting `isUnitPriceTaxIncluded` to `true`

    still means the price you are sending includes tax. `margin`, `markupRate` and

    `marginRate` are derived by the server and ignored if sent.'
  contact:
    name: Altoviz
    email: contact@altoviz.com
  license:
    name: Altoviz license
    url: https://altoviz.com/license
  version: v1
  x-logo:
    url: https://altoviz.com/altoviz-logo-ext-violet-262x72.png
    altText: Altoviz logo
servers:
- url: https://api.altoviz.com
  description: Altoviz
security:
- {}
tags:
- name: CustomerFamilies
  description: Customers API
paths:
  /v1/customerfamilies:
    get:
      tags:
      - CustomerFamilies
      summary: List customer families
      operationId: GET_CustomerFamilies_List
      parameters:
      - name: PageIndex
        in: query
        schema:
          type: integer
          format: int32
      - name: PageSize
        in: query
        schema:
          type: integer
          format: int32
      - name: OrderBy
        in: query
        schema:
          type: string
      - name: query
        in: query
        description: query (full text search)
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers:
            x-page-prev:
              description: Relative URL of previous page when available
              schema:
                type: string
            x-page-next:
              description: Relative URL of next page when available
              schema:
                type: string
            x-page-count:
              description: Total number of pages
              schema:
                type: integer
                format: int32
            x-record-count:
              description: Total number of matching records
              schema:
                type: integer
                format: int32
            x-page-index:
              description: Current page index
              schema:
                type: integer
                format: int32
            x-page-size:
              description: Current page size
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomerFamily'
    post:
      tags:
      - CustomerFamilies
      summary: Create a new customer family
      operationId: POST_CustomerFamilies_Post
      requestBody:
        description: Customer family to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerFamily'
          text/json:
            schema:
              $ref: '#/components/schemas/CustomerFamily'
          application/*+json:
            schema:
              $ref: '#/components/schemas/CustomerFamily'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerFamily'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /v1/customerfamilies/find:
    get:
      tags:
      - CustomerFamilies
      summary: Find a customer family
      operationId: GET_CustomerFamilies_Find
      parameters:
      - name: number
        in: query
        description: Number
        schema:
          type: string
      - name: internalId
        in: query
        description: Internal ID
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomerFamily'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /v1/customerfamilies/{id}:
    get:
      tags:
      - CustomerFamilies
      summary: Get a customer family by ID
      operationId: GET_CustomerFamilies_Get
      parameters:
      - name: id
        in: path
        description: Customer family id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerFamily'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    delete:
      tags:
      - CustomerFamilies
      summary: Delete a customer family
      operationId: DELETE_CustomerFamilies_Delete
      parameters:
      - name: id
        in: path
        description: Customer family id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    CustomerFamily:
      type: object
      properties:
        id:
          type: integer
          description: ID
          format: int32
          readOnly: true
        internalId:
          type:
          - string
          - 'null'
          description: Internal ID
        label:
          type:
          - string
          - 'null'
          description: Label
        number:
          type:
          - string
          - 'null'
          description: Number
      additionalProperties: false
      description: Customer family
    ProblemDetails:
      type: object
      properties:
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        title:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
      additionalProperties: {}
    Error:
      type: object
      properties:
        errors:
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of error messages
        message:
          type:
          - string
          - 'null'
          description: Error message
      additionalProperties: false
      description: Error
  securitySchemes:
    ApiKey:
      type: apiKey
      description: 'API KEY generated in application. Example: "X-API-KEY: {apiKey}"'
      name: X-API-KEY
      in: header