Skip to content

Latest commit

 

History

History
610 lines (392 loc) · 19.3 KB

EntriesAPI.md

File metadata and controls

610 lines (392 loc) · 19.3 KB

\EntriesAPI

All URIs are relative to https://api.attio.com

Method HTTP request Description
V2ListsListEntriesEntryIdAttributesAttributeValuesGet Get /v2/lists/{list}/entries/{entry_id}/attributes/{attribute}/values List attribute values for a list entry
V2ListsListEntriesEntryIdDelete Delete /v2/lists/{list}/entries/{entry_id} Delete a list entry
V2ListsListEntriesEntryIdGet Get /v2/lists/{list}/entries/{entry_id} Get a list entry
V2ListsListEntriesEntryIdPatch Patch /v2/lists/{list}/entries/{entry_id} Update a list entry (append multiselect values)
V2ListsListEntriesEntryIdPut Put /v2/lists/{list}/entries/{entry_id} Update a list entry (overwrite multiselect values)
V2ListsListEntriesPost Post /v2/lists/{list}/entries Create an entry (add record to list)
V2ListsListEntriesPut Put /v2/lists/{list}/entries Assert a list entry by parent
V2ListsListEntriesQueryPost Post /v2/lists/{list}/entries/query List entries

V2ListsListEntriesEntryIdAttributesAttributeValuesGet

V2ObjectsObjectRecordsRecordIdAttributesAttributeValuesGet200Response V2ListsListEntriesEntryIdAttributesAttributeValuesGet(ctx, list, entryId, attribute).ShowHistoric(showHistoric).Limit(limit).Offset(offset).Execute()

List attribute values for a list entry

Example

package main

import (
	"context"
	"fmt"
	"os"
	libattio "github.com/sid6mathur/libattio"
)

func main() {
	list := "enterprise_sales" // string | 
	entryId := "2e6e29ea-c4e0-4f44-842d-78a891f8c156" // string | 
	attribute := "41252299-f8c7-4b5e-99c9-4ff8321d2f96" // string | 
	showHistoric := true // bool |  (optional) (default to false)
	limit := int32(10) // int32 |  (optional)
	offset := int32(5) // int32 |  (optional)

	configuration := libattio.NewConfiguration()
	apiClient := libattio.NewAPIClient(configuration)
	resp, r, err := apiClient.EntriesAPI.V2ListsListEntriesEntryIdAttributesAttributeValuesGet(context.Background(), list, entryId, attribute).ShowHistoric(showHistoric).Limit(limit).Offset(offset).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EntriesAPI.V2ListsListEntriesEntryIdAttributesAttributeValuesGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `V2ListsListEntriesEntryIdAttributesAttributeValuesGet`: V2ObjectsObjectRecordsRecordIdAttributesAttributeValuesGet200Response
	fmt.Fprintf(os.Stdout, "Response from `EntriesAPI.V2ListsListEntriesEntryIdAttributesAttributeValuesGet`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
list string
entryId string
attribute string

Other Parameters

Other parameters are passed through a pointer to a apiV2ListsListEntriesEntryIdAttributesAttributeValuesGetRequest struct via the builder pattern

Name Type Description Notes

showHistoric | bool | | [default to false] limit | int32 | | offset | int32 | |

Return type

V2ObjectsObjectRecordsRecordIdAttributesAttributeValuesGet200Response

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V2ListsListEntriesEntryIdDelete

map[string]interface{} V2ListsListEntriesEntryIdDelete(ctx, list, entryId).Execute()

Delete a list entry

Example

package main

import (
	"context"
	"fmt"
	"os"
	libattio "github.com/sid6mathur/libattio"
)

func main() {
	list := "enterprise_sales" // string | 
	entryId := "2e6e29ea-c4e0-4f44-842d-78a891f8c156" // string | 

	configuration := libattio.NewConfiguration()
	apiClient := libattio.NewAPIClient(configuration)
	resp, r, err := apiClient.EntriesAPI.V2ListsListEntriesEntryIdDelete(context.Background(), list, entryId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EntriesAPI.V2ListsListEntriesEntryIdDelete``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `V2ListsListEntriesEntryIdDelete`: map[string]interface{}
	fmt.Fprintf(os.Stdout, "Response from `EntriesAPI.V2ListsListEntriesEntryIdDelete`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
list string
entryId string

Other Parameters

Other parameters are passed through a pointer to a apiV2ListsListEntriesEntryIdDeleteRequest struct via the builder pattern

Name Type Description Notes

Return type

map[string]interface{}

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V2ListsListEntriesEntryIdGet

V2ListsListEntriesPut200Response V2ListsListEntriesEntryIdGet(ctx, list, entryId).Execute()

Get a list entry

Example

package main

import (
	"context"
	"fmt"
	"os"
	libattio "github.com/sid6mathur/libattio"
)

func main() {
	list := "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" // string | 
	entryId := "2e6e29ea-c4e0-4f44-842d-78a891f8c156" // string | 

	configuration := libattio.NewConfiguration()
	apiClient := libattio.NewAPIClient(configuration)
	resp, r, err := apiClient.EntriesAPI.V2ListsListEntriesEntryIdGet(context.Background(), list, entryId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EntriesAPI.V2ListsListEntriesEntryIdGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `V2ListsListEntriesEntryIdGet`: V2ListsListEntriesPut200Response
	fmt.Fprintf(os.Stdout, "Response from `EntriesAPI.V2ListsListEntriesEntryIdGet`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
list string
entryId string

Other Parameters

Other parameters are passed through a pointer to a apiV2ListsListEntriesEntryIdGetRequest struct via the builder pattern

Name Type Description Notes

Return type

V2ListsListEntriesPut200Response

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V2ListsListEntriesEntryIdPatch

V2ListsListEntriesPut200Response V2ListsListEntriesEntryIdPatch(ctx, list, entryId).V2ListsListEntriesEntryIdPatchRequest(v2ListsListEntriesEntryIdPatchRequest).Execute()

Update a list entry (append multiselect values)

Example

package main

import (
	"context"
	"fmt"
	"os"
	libattio "github.com/sid6mathur/libattio"
)

func main() {
	list := "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" // string | 
	entryId := "2e6e29ea-c4e0-4f44-842d-78a891f8c156" // string | 
	v2ListsListEntriesEntryIdPatchRequest := *libattio.NewV2ListsListEntriesEntryIdPatchRequest(*libattio.NewV2ListsListEntriesEntryIdPatchRequestData(map[string][]interface{}{"key": []interface{}{nil}})) // V2ListsListEntriesEntryIdPatchRequest | 

	configuration := libattio.NewConfiguration()
	apiClient := libattio.NewAPIClient(configuration)
	resp, r, err := apiClient.EntriesAPI.V2ListsListEntriesEntryIdPatch(context.Background(), list, entryId).V2ListsListEntriesEntryIdPatchRequest(v2ListsListEntriesEntryIdPatchRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EntriesAPI.V2ListsListEntriesEntryIdPatch``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `V2ListsListEntriesEntryIdPatch`: V2ListsListEntriesPut200Response
	fmt.Fprintf(os.Stdout, "Response from `EntriesAPI.V2ListsListEntriesEntryIdPatch`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
list string
entryId string

Other Parameters

Other parameters are passed through a pointer to a apiV2ListsListEntriesEntryIdPatchRequest struct via the builder pattern

Name Type Description Notes

v2ListsListEntriesEntryIdPatchRequest | V2ListsListEntriesEntryIdPatchRequest | |

Return type

V2ListsListEntriesPut200Response

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V2ListsListEntriesEntryIdPut

V2ListsListEntriesPut200Response V2ListsListEntriesEntryIdPut(ctx, list, entryId).V2ListsListEntriesEntryIdPutRequest(v2ListsListEntriesEntryIdPutRequest).Execute()

Update a list entry (overwrite multiselect values)

Example

package main

import (
	"context"
	"fmt"
	"os"
	libattio "github.com/sid6mathur/libattio"
)

func main() {
	list := "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" // string | 
	entryId := "2e6e29ea-c4e0-4f44-842d-78a891f8c156" // string | 
	v2ListsListEntriesEntryIdPutRequest := *libattio.NewV2ListsListEntriesEntryIdPutRequest(*libattio.NewV2ListsListEntriesEntryIdPutRequestData(map[string][]interface{}{"key": []interface{}{nil}})) // V2ListsListEntriesEntryIdPutRequest | 

	configuration := libattio.NewConfiguration()
	apiClient := libattio.NewAPIClient(configuration)
	resp, r, err := apiClient.EntriesAPI.V2ListsListEntriesEntryIdPut(context.Background(), list, entryId).V2ListsListEntriesEntryIdPutRequest(v2ListsListEntriesEntryIdPutRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EntriesAPI.V2ListsListEntriesEntryIdPut``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `V2ListsListEntriesEntryIdPut`: V2ListsListEntriesPut200Response
	fmt.Fprintf(os.Stdout, "Response from `EntriesAPI.V2ListsListEntriesEntryIdPut`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
list string
entryId string

Other Parameters

Other parameters are passed through a pointer to a apiV2ListsListEntriesEntryIdPutRequest struct via the builder pattern

Name Type Description Notes

v2ListsListEntriesEntryIdPutRequest | V2ListsListEntriesEntryIdPutRequest | |

Return type

V2ListsListEntriesPut200Response

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V2ListsListEntriesPost

V2ListsListEntriesPut200Response V2ListsListEntriesPost(ctx, list).V2ListsListEntriesPutRequest(v2ListsListEntriesPutRequest).Execute()

Create an entry (add record to list)

Example

package main

import (
	"context"
	"fmt"
	"os"
	libattio "github.com/sid6mathur/libattio"
)

func main() {
	list := "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" // string | 
	v2ListsListEntriesPutRequest := *libattio.NewV2ListsListEntriesPutRequest(*libattio.NewV2ListsListEntriesPutRequestData("891dcbfc-9141-415d-9b2a-2238a6cc012d", "people", map[string][]interface{}{"key": []interface{}{nil}})) // V2ListsListEntriesPutRequest | 

	configuration := libattio.NewConfiguration()
	apiClient := libattio.NewAPIClient(configuration)
	resp, r, err := apiClient.EntriesAPI.V2ListsListEntriesPost(context.Background(), list).V2ListsListEntriesPutRequest(v2ListsListEntriesPutRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EntriesAPI.V2ListsListEntriesPost``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `V2ListsListEntriesPost`: V2ListsListEntriesPut200Response
	fmt.Fprintf(os.Stdout, "Response from `EntriesAPI.V2ListsListEntriesPost`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
list string

Other Parameters

Other parameters are passed through a pointer to a apiV2ListsListEntriesPostRequest struct via the builder pattern

Name Type Description Notes

v2ListsListEntriesPutRequest | V2ListsListEntriesPutRequest | |

Return type

V2ListsListEntriesPut200Response

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V2ListsListEntriesPut

V2ListsListEntriesPut200Response V2ListsListEntriesPut(ctx, list).V2ListsListEntriesPutRequest(v2ListsListEntriesPutRequest).Execute()

Assert a list entry by parent

Example

package main

import (
	"context"
	"fmt"
	"os"
	libattio "github.com/sid6mathur/libattio"
)

func main() {
	list := "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" // string | 
	v2ListsListEntriesPutRequest := *libattio.NewV2ListsListEntriesPutRequest(*libattio.NewV2ListsListEntriesPutRequestData("891dcbfc-9141-415d-9b2a-2238a6cc012d", "people", map[string][]interface{}{"key": []interface{}{nil}})) // V2ListsListEntriesPutRequest | 

	configuration := libattio.NewConfiguration()
	apiClient := libattio.NewAPIClient(configuration)
	resp, r, err := apiClient.EntriesAPI.V2ListsListEntriesPut(context.Background(), list).V2ListsListEntriesPutRequest(v2ListsListEntriesPutRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EntriesAPI.V2ListsListEntriesPut``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `V2ListsListEntriesPut`: V2ListsListEntriesPut200Response
	fmt.Fprintf(os.Stdout, "Response from `EntriesAPI.V2ListsListEntriesPut`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
list string

Other Parameters

Other parameters are passed through a pointer to a apiV2ListsListEntriesPutRequest struct via the builder pattern

Name Type Description Notes

v2ListsListEntriesPutRequest | V2ListsListEntriesPutRequest | |

Return type

V2ListsListEntriesPut200Response

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V2ListsListEntriesQueryPost

V2ListsListEntriesQueryPost200Response V2ListsListEntriesQueryPost(ctx, list).V2ListsListEntriesQueryPostRequest(v2ListsListEntriesQueryPostRequest).Execute()

List entries

Example

package main

import (
	"context"
	"fmt"
	"os"
	libattio "github.com/sid6mathur/libattio"
)

func main() {
	list := "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" // string | 
	v2ListsListEntriesQueryPostRequest := *libattio.NewV2ListsListEntriesQueryPostRequest() // V2ListsListEntriesQueryPostRequest | 

	configuration := libattio.NewConfiguration()
	apiClient := libattio.NewAPIClient(configuration)
	resp, r, err := apiClient.EntriesAPI.V2ListsListEntriesQueryPost(context.Background(), list).V2ListsListEntriesQueryPostRequest(v2ListsListEntriesQueryPostRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EntriesAPI.V2ListsListEntriesQueryPost``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `V2ListsListEntriesQueryPost`: V2ListsListEntriesQueryPost200Response
	fmt.Fprintf(os.Stdout, "Response from `EntriesAPI.V2ListsListEntriesQueryPost`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
list string

Other Parameters

Other parameters are passed through a pointer to a apiV2ListsListEntriesQueryPostRequest struct via the builder pattern

Name Type Description Notes

v2ListsListEntriesQueryPostRequest | V2ListsListEntriesQueryPostRequest | |

Return type

V2ListsListEntriesQueryPost200Response

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]