AHaha
Custom table records

Get a specific custom table record

Changed on

Custom tables have a different set of records for each product. This means that if you want to create one or list them you must scope them to a product.

Once you have the ID of a specific custom table record, you can get, modify, or delete them on the root custom table records resource.

Custom tables are an Enterprise+ exclusive feature.

get/custom_object_records/{id}

Request

  • Base URL
    https://company.aha.io/api/v1
  • Auth
    • OAuth 2
      Authorization codehttps://{account-domain}.aha.io/oauth/authorize
      Token URLhttps://{account-domain}.aha.io/oauth/token
    • or HTTP bearer
    • or API key in cookie session
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Id identifier

Response

Successful operation

Example response

{
  "custom_object_records": [
    {
      "id": "8397122",
      "product_id": "131414752",
      "key": "customers",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "custom_fields": [
        {
          "id": 564906240,
          "key": "name",
          "name": "Name",
          "updatedAt": "2019-01-01T00:00:00Z",
          "type": "string",
          "value": "Zane Corp"
        }
      ],
      "custom_object_links": [
        {
          "key": "custom_table_name_link_many",
          "name": "Custom Table Linked Records",
          "record_type": "CustomObjectRecord",
          "record_ids": []
        },
        {
          "key": "custom_table_name_link_many_to_one",
          "name": "Custom Table Many to One Field",
          "record_type": "CustomObjectRecord",
          "record_ids": []
        },
        {
          "key": "custom_table_name_submitters",
          "name": "Custom Table Linked Submitters",
          "record_type": "CustomObjectRecord",
          "record_ids": []
        }
      ],
      "linked_records": [],
      "created_by_user": {
        "id": "1020675218",
        "name": "Mary Humpty",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      }
    },
    {
      "id": "640362830",
      "product_id": "131414752",
      "key": "customers",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "custom_fields": [
        {
          "id": 262515157,
          "key": "name",
          "name": "Name",
          "updatedAt": "2019-01-01T00:00:00Z",
          "type": "string",
          "value": "Acme Corp"
        },
        {
          "id": 883926222,
          "key": "website",
          "name": "Website",
          "updatedAt": "2019-01-01T00:00:00Z",
          "type": "url",
          "value": "www.acme.com"
        }
      ],
      "custom_object_links": [
        {
          "key": "custom_table_name_link_many",
          "name": "Custom Table Linked Records",
          "record_type": "CustomObjectRecord",
          "record_ids": [
            1059223798
          ]
        },
        {
          "key": "custom_table_name_link_many_to_one",
          "name": "Custom Table Many to One Field",
          "record_type": "CustomObjectRecord",
          "record_ids": []
        },
        {
          "key": "custom_table_name_submitters",
          "name": "Custom Table Linked Submitters",
          "record_type": "CustomObjectRecord",
          "record_ids": []
        }
      ],
      "linked_records": [
        {
          "key": "customers",
          "name": "Customers",
          "record_type": "Ideas::Idea",
          "record_id": 162120796
        },
        {
          "key": "revenue",
          "name": "Revenue",
          "record_type": "Ideas::Idea",
          "record_id": 58056975
        },
        {
          "key": "submitters",
          "name": "Submitters",
          "record_type": "Ideas::Idea",
          "record_id": 58056975
        }
      ],
      "created_by_user": {
        "id": "1020675218",
        "name": "Mary Humpty",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      }
    }
  ],
  "pagination": {
    "total_records": 2,
    "total_pages": 1,
    "current_page": 1
  }
}

Changes