https://github.com/sgerrand/ex_attio
Elixir client for the Attio API
https://github.com/sgerrand/ex_attio
api-client api-client-elixir attio-sdk elixir-library hex-package
Last synced: about 1 month ago
JSON representation
Elixir client for the Attio API
- Host: GitHub
- URL: https://github.com/sgerrand/ex_attio
- Owner: sgerrand
- License: bsd-2-clause
- Created: 2026-04-20T13:55:48.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2026-06-03T12:02:39.000Z (about 2 months ago)
- Last Synced: 2026-06-03T13:15:37.070Z (about 2 months ago)
- Topics: api-client, api-client-elixir, attio-sdk, elixir-library, hex-package
- Language: Elixir
- Homepage: https://hexdocs.pm/attio
- Size: 109 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Attio
[](https://github.com/sgerrand/ex_attio/actions/workflows/ci.yml)
[](https://coveralls.io/github/sgerrand/ex_attio?branch=main)
[](https://hex.pm/packages/attio)
[](https://hexdocs.pm/attio/)
An Elixir client for the [Attio REST API](https://developers.attio.com).
## Installation
Add `attio` to your dependencies in `mix.exs`:
```elixir
def deps do
[
{:attio, "~> 0.3.0"}
]
end
```
## Usage
```elixir
client = Attio.Client.new(api_key: System.fetch_env!("ATTIO_API_KEY"))
# List people
{:ok, response} = Attio.Records.list(client, "people")
# Stream all companies across pages
companies =
client
|> Attio.Records.stream("companies")
|> Enum.to_list()
# Create a person record
{:ok, record} =
Attio.Records.create(client, "people", %{
"name" => [%{"first_name" => "Alice", "last_name" => "Smith"}],
"email_addresses" => [%{"email_address" => "alice@example.com"}]
})
# Upsert (assert) a record
{:ok, %{"action" => action}} =
Attio.Records.assert(client, "people", %{
"email_addresses" => [%{"email_address" => "alice@example.com"}]
})
```
All functions return `{:ok, response}` or `{:error, %Attio.Error{}}`. See the
`Attio` module for a full resource reference and the [Attio API docs](https://developers.attio.com)
for attribute value formats.
## Development
### Prerequisites
This project targets Elixir ~> 1.17 and OTP 25–28. The exact versions used for
development are pinned in `.tool-versions`:
- Erlang 28.4
- Elixir 1.19.4-otp-28
If you use [asdf](https://asdf-vm.com) or [mise](https://mise.jdx.dev), the
correct versions will be selected automatically.
### Getting started
```bash
mix deps.get # fetch dependencies
mix test # run the test suite
```
### Code quality
```bash
mix format # auto-format source files
mix format --check-formatted # check formatting (run by CI)
mix credo --strict # static analysis
mix dialyzer # type analysis (run by CI; first run builds the PLT)
```
### Generating documentation
```bash
mix docs
```
Open `doc/index.html` in a browser to preview the generated site.
## License
Attio is [released under the BSD 2-Clause license](LICENSE).